Why is this endpoint not under /api/v2/?

Excel operations belong to the PDF4me office API family, addressed as office/ApiV2Excel/ plus the action name on the same api.pdf4me.com host, with the same Basic Authorization header.

Desbloquear Excel

PDF4me Desbloquear Excel é um REST endpoint que remove a proteção por senha de um Excel planilha quando você fornecer a senha correta. POST o arquivo protegido como Base64 para office/ApiV2Excel/ExcelUnlock, insira a senha dentro unlockExcelActione salve a cópia decodificada e desprotegida do JSON resposta. Remove a proteção; nunca a quebra.

O que este endpoint faz

Recebe uma pasta de trabalho protegida, juntamente com sua senha, e retorna uma cópia desprotegida. A criptografia de arquivos, a proteção da estrutura da pasta de trabalho e os bloqueios de planilhas são removidos em uma única operação, o que é essencial para que os fluxos de trabalho automatizados possam ler células, adicionar linhas ou mesclar arquivos: a cada dois Excel A ação espera uma planilha desprotegida. A resposta é JSON com o resultado sendo Base64 contente.

Autenticando seu API Solicitar

Todo PDF4me REST A chamada deve incluir o seu API chave no Authorization Defina o cabeçalho como autenticação básica. Obtenha ou altere sua chave no painel do desenvolvedor.

Get your API Key

Ponto final

POSToffice/ApiV2Excel/ExcelUnlock

carteiro URLhttps://api.pdf4me.com/office/ApiV2Excel/ExcelUnlock

Fatos importantes que você não deve perder

Requer a senha correta. Não é um cracker.

O API A proteção é removida quando você fornece a senha usada para aplicá-la. Ela não pode contornar, recuperar ou usar força bruta em uma senha desconhecida; uma senha incorreta retorna success: falso.

Nunca insira a senha diretamente no código-fonte.

Os corpos das requisições acabam em scripts, logs e sistemas de controle de versão. Injetar desbloquearAçãoExcel.senha A partir de uma variável de ambiente ou gerenciador de segredos, aplica-se a mesma regra que qualquer credencial.

Primeiro desbloqueie, depois automatize.

Outro Excel As ações (adicionar linhas, extrair planilhas, mesclar arquivos) esperam uma pasta de trabalho desprotegida. Encadeie o ExcelUnlock como primeira etapa e alimente sua saída nos processos subsequentes.

HTTP configurar

Método: POST
URL: https://api.pdf4me.com/office/ApiV2Excel/ExcelUnlock
Tipo de conteúdo: aplicativo/json
Authorization: Básico <seu PDF4me API chave>

A resposta é JSON: verifique o success bandeira, então Base64-decodificar o conteúdo da planilha retornada e salvá-lo com um .xlsx extensão.

Quais proteções o desbloqueio remove?

Excel A proteção é em camadas, e cada camada se comporta de maneira diferente. Desbloquear com a senha correta remove todas elas de uma só vez.

Proteção versus comportamento	O que ele bloqueia	Removido por este API
Criptografia de arquivos	Abrir o arquivo sem a senha é impossível.	Sim, com a senha correta.
Proteção da estrutura do caderno de exercícios	Adicionar, excluir ou reordenar planilhas	Sim
Proteção da folha de exercícios	Editando células em uma folha bloqueada	Sim
Uma senha desconhecida e perdida.	Tudo acima	Não. É necessário inserir a senha correta.

API campos corporais

Parâmetro	Obrigatório	Tipo	O que faz	Exemplo
`document`	Required	object	Document reference carrying Name, the protected Excel filename with its extension.	`{ "Name": "data.xlsx" }`
`docContent`	Required	string	Base64-encoded bytes of the password-protected workbook.	`UEsDBBQABgAIAAAA...`
`unlockExcelAction`	Required	object	Action configuration object holding the password and optional culture settings.	`{ "password": "..." }`
`password`	Required	string	Inside the action object. The password that was used to protect the file. Inject from a secret store; never hardcode.	`{{EXCEL_PASSWORD}}`
`cultureName`	Optional	string	Inside the action object. Culture code applied during processing.	`en-US`

Exemplos de cargas úteis

Desbloqueie com uma senha secreta inserida.

{
 "document": { "Name": "data.xlsx" },
 "docContent": "UEsDBBQABgAIAAAA...",
 "unlockExcelAction": {
 "password": "{{EXCEL_PASSWORD}}"
 }
}

Desbloqueie com uma cultura explícita

{
 "document": { "Name": "quarterly-report.xlsx" },
 "docContent": "UEsDBBQABgAIAAAA...",
 "unlockExcelAction": {
 "password": "{{EXCEL_PASSWORD}}",
 "cultureName": "en-US"
 }
}

Dicas de coleta do carteiro

Headers

Content-Type: application/json + Authorization: Basic <apiKey>.

Body

raw JSON. The password goes INSIDE unlockExcelAction, not at the root. Use a Postman environment variable for it.

Response

JSON with a success flag and Base64 workbook content. Decode the content before saving as .xlsx.

Failures

A wrong password returns success false with an errorMessage; nothing is partially unlocked and the source is untouched.

exemplo de curl

curl -X POST https://api.pdf4me.com/office/ApiV2Excel/ExcelUnlock \
 -H "Content-Type: application/json" \
 -H "Authorization: Basic YOUR_API_KEY" \
 -d '{
 "document": { "Name": "data.xlsx" },
 "docContent": "'"$(base64 -w 0 data.xlsx)"'",
 "unlockExcelAction": {
 "password": "'"$EXCEL_PASSWORD"'"
 }
 }' \
 --output response.json

O que significa o API retornar?

A JSON resultado carregando a planilha desprotegida como Base64.

Campo	Tipo	O que contém
`document`	String (Base64)	The unprotected workbook content. Decode to bytes and save with an .xlsx extension.
`fileName`	String	Output filename for the unlocked workbook.
`success`	Boolean	true when unlocking succeeded. Check this before decoding content.
`errorMessage`	String	Populated when success is false, including the wrong-password case.

Exemplos de código

Excel Os endpoints de escritório ainda não são cobertos por per-language pastas de exemplo; o repositório de exemplos contém o padrão de requisição usado por todos. PDF4me família de endpoints:

View API Samples Repository

Perguntas frequentes

Can this API unlock an Excel file without the password?+

No. The unlock action removes protection using the correct password you supply in unlockExcelAction.password. It is a workflow tool for files whose password you legitimately hold, not a password cracker or recovery service.

Which kinds of Excel protection does it remove?+

File encryption (the password prompt when opening), workbook structure protection, and worksheet protection are removed in one pass, returning a fully unprotected copy of the workbook.

Is the response the file itself?+

No. The API returns JSON containing the unlocked workbook as a Base64 string plus fileName, success, and errorMessage fields. Decode the content to bytes before saving as .xlsx.

What happens if I send the wrong password?+

The operation fails: success comes back false and errorMessage explains the failure. The workbook is never partially unlocked and your source file is never modified.

Does unlocking change the workbook contents?+

No. Cells, formulas, formatting, and sheets are untouched. Only the protection layers are removed; the output is the same workbook without the locks.

How do I keep the password out of my scripts?+

Inject it at runtime: a Postman environment variable, an environment variable in shell scripts, or a secrets manager in production code. Request bodies frequently end up in logs and version control, so treat the payload as sensitive.

Can I re-protect the file after processing?+

Yes. Chain the Secure Excel action after your processing steps to apply fresh protection to the finished workbook.

Por que desbloquear via API em vez de manualmente?

O procedimento manual para uma trava de segurança em nível de folha é desprotegendo a folha em ExcelAbra o arquivo, insira a senha, vá na guia Revisão, desproteja a planilha, salve e repita o processo para cada arquivo. Isso não é viável para uma pasta noturna de relatórios protegidos. API Executa a mesma remoção com verificação de senha que uma solicitação determinística por arquivo, e a saída permanece padrão. Escritório aberto XML Planilha pronta para o restante do processo.