Documentação API
Transforme seus documentos com facilidade e eficiência com nossa API
Sumário
Configuração e utilização do Webhook
Para receber o resultado do processamento dos documentos enviados à nossa API, você deve configurar um Webhook em sua aplicação. Siga os passos abaixo para configurar e utilizar o Webhook corretamente.
Passo 1: Cadastar o Webhook
- Acesse a dashboard e navegue até a aba Integração.
- Clique na sub-aba Webhook.
- Clique no botão Cadastrar para adicionar uma nova rota de Webhook.
- Adicione a URL da sua API que deve receber o resultado do processamento da fila de criação do documento.
- Escolha o tipo de Webhook Documento criado.
Após cadastrar, anote o código gerado (ID) que aparece ao lado da URL na lista de Webhook. Este código será utilizado como senha na autenticação.
Passo 2: Configurar a rota do Webhook
A rota que você cadastrar deve ser um POST e deve estar preparada para receber os seguintes campos no corpo da requisição, no formato JSON:
| Campo | Tipo | Descrição |
|---|---|---|
|
status |
string |
Indica o status do processamento: Success ou Error. |
|
pdf_url |
string |
URL para download do documento em PDF. |
|
word_url |
string |
URL para download do documento em Word. |
|
queue_id |
string |
ID da fila de processamento. |
Exemplo de corpo da Requisição
Em caso de sucesso
{
"status": "Success",
"pdf_url": "https://api.seudominio.com/download/seu_documento.pdf",
"word_url": "https://api.seudominio.com/download/seu_documento.docx",
"queue_id": "12345"
}
Em caso de erro
{
"status": "Error",
"pdf_url": "none",
"word_url": "none",
"queue_id": "12345"
}
Autenticação do Webhook
A rota do Webhook deve utilizar autenticação do tipo Basic Authentication. Os detalhes de autenticação são os seguintes:
Username: uxdoc
Senha: Código gerado ao criar o Webhook (ID do Webhook).
Importância do download dos documentos
As URLs fornecidas para download dos documentos (PDF e Word) são válidas por apenas 1 dia. Portanto, é essencial que você realize o download e armazene os documentos em seu ambiente assim que receber a notificação via Webhook.
Tratamento de erros
Em caso de erro no processamento (status “Error”), você receberá apenas o queue_id e o status, com os campos pdf_url e word_url definidos como “none”. Neste caso, será necessário reenviar o documento para processamento. Documentos reenviados devido a erros não serão cobrados dos seus créditos.
Para mais informações sobre como funcionam os créditos, consulte este link.