API para desenvolvedores
Chame as ferramentas do seu próprio software sem precisar de um navegador: envie uma requisição, inicie uma tarefa e baixe o resultado. Todos os endpoints ficam em um único endereço versionado; cada requisição é autorizada com uma chave pessoal.
Fluxo de tarefas
Uma chamada inicia uma tarefa de conversão e retorna o ID da tarefa. Com esse ID, você consulta o status e faz o download do resultado assim que ela terminar. Como as tarefas podem demorar, essa divisão permite aguardar sem travar seu fluxo.
Chave e acesso
As requisições são assinadas com o cabeçalho Authorization: Bearer. Crie sua chave na sua conta e revogue-a quando quiser; a chave em texto simples é exibida apenas no momento da criação. Uma sessão do navegador não é considerada autenticação aqui.
Ferramentas com API aberta
| Ferramenta | Interface da API | Documento |
|---|---|---|
| ImagemMini | Conversor — POST /run | Documento |
| Livro de Receitas e Despesas | 10 endpoints (aplicativo com estado) | Documento |
| PdfSplit | Conversor — POST /run | Documento |
Versionamento e contrato
Os endpoints são versionados sob https://api.pixepi.com com /api/v1; alterações incompatíveis exigem uma nova versão. O contrato legível por máquina é publicado como OpenAPI 3.1 e pode ser usado diretamente em geradores de clientes.
Respostas e erros
As respostas vêm em um envelope JSON; cada tarefa é consultada pelo seu próprio ID e a titularidade do registro é verificada no servidor. Se algo der errado, a resposta retorna um código descritivo; o cliente traduz esse código para o seu próprio idioma.
Mais detalhes
- O link da API na página da ferramenta escolhida; ele abre os endpoints, campos de requisição, opções e o comportamento de erro dessa ferramenta.
- Contrato legível por máquina: documento OpenAPI.
- Página central do desenvolvedor: lista compartilhada de todos os endpoints.