Dividir pdf API
Dividir pdf API, PdfSplit conecta o trabalho ao seu aplicativo: você envia o arquivo, consulta o status e baixa o resultado. Os endpoints rodam no servidor, sem necessidade de navegador.
Início rápido
- Crie uma chave na seção API para Desenvolvedores da sua conta em https://pixepi.com/pt/conta; a chave em texto simples é exibida apenas no momento da criação.
- Envie a requisição para https://api.pixepi.com com o cabeçalho Authorization: Bearer
. - Consulte o status do trabalho retornado com GET https://api.pixepi.com/api/v1/jobs/{id}; assim que o status for done, baixe o resultado a partir de download_url.
Exemplo de requisição
curl -X POST "https://api.pixepi.com/api/v1/apps/pdfsplit/run" \
-H "Authorization: Bearer $PIXEPI_KEY" \
-F "[email protected]" \
-F "options[mode]=pages" \
-F "options[page_range]=1-3"
curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/jobs/42"Endpoints desta ferramenta
| Método | Caminho | O que faz |
|---|---|---|
POST | /run | Executa a ferramenta, inicia um trabalho e retorna o resultado. |
Opções
As opções são enviadas como options[<field>]; um campo deixado vazio usa seu valor padrão.
| Campo | Valores | Padrão |
|---|---|---|
options[mode]Modo de divisão | pages · range · chunks | pages |
options[page_range]Intervalos de páginas | 1-3 | |
options[chunk_size]Tamanho do bloco | 1–500 | 5 |
options[merge_output]Unir os intervalos em um único PDF | ativado · desativado | desativado |
Endpoints compartilhados
| Método | Caminho | O que faz |
|---|---|---|
GET | /api/v1/apps | Catálogo da API |
GET | /api/v1/apps/pdfsplit | Contrato da ferramenta |
GET | /api/v1/jobs/{id} | Status da tarefa |
GET | /api/v1/jobs/{id}/download | Baixar o resultado da tarefa |
GET | /api/v1/usage | Resumo de uso |
GET | /api/v1/openapi.json | Documento OpenAPI 3.1 |
Limites
- No máximo 100 MB por arquivo.
- As informações de cota e plano estão vinculadas à sua conta; confira o status atual com
GET /api/v1/usage.
Códigos de erro
| Código | Significado |
|---|---|
unauthorized | A chave de API está ausente ou é inválida. |
forbidden | Esta operação não é permitida com esta chave. |
not_found | Ferramenta, tarefa ou registro não encontrado (404 também para acesso entre contas). |
invalid_input | A validação dos dados falhou (campo ausente ou inválido, data incorreta, etc.). |
invalid_request | A requisição está malformatada. |
too_large | O arquivo ou o tamanho do corpo excede o limite. |
unsupported_media | O tipo de arquivo não é aceito. |
not_supported | Esta ferramenta não pode ser executada neste endpoint (aplicação com estado). |
not_ready | A tarefa ainda não foi concluída. |
expired | O arquivo gerado expirou. |
no_output | Não há resultado disponível para download nesta tarefa. |
invalid_path | Caminho de saída inválido. |
quota_exceeded | Limite de cota ou de taxa excedido. |
rate_limited | Muitas requisições em pouco tempo. Aguarde um instante e tente novamente. |
csrf | A verificação do formulário falhou (a API externa usa chaves). |
conflict | A operação entra em conflito com o estado atual. |
unavailable | A ferramenta está temporariamente indisponível. |
internal_error | Erro interno inesperado no servidor. |
Documentos
Perguntas frequentes
Onde posso obter uma chave de API?
Crie uma chave na seção API para Desenvolvedores da sua conta; a chave é exibida apenas uma vez, no momento da criação.
Como uma requisição é enviada?
Os endpoints operam em https://api.pixepi.com; cada requisição deve incluir o cabeçalho "Authorization: Bearer <key>".
Quais arquivos a API de PdfSplit aceita?
Tipos aceitos: PDF. O limite é de 100 MB por arquivo; as opções são as mesmas da página da ferramenta.
Como interpretar uma resposta de erro?
O corpo do erro inclui os campos {ok:false, error, code, request_id}; os valores de code constam na tabela de códigos de erro.