Solução de Problemas e Erros Comuns na API
Ao integrar a D4Sign via API, é comum encontrar alguns erros. Este guia detalha os erros mais frequentes e como solucioná-los. Para auxiliar nos testes, recomendamos usar o Postman com a nossa coleção e consultar a documentação completa.
Para auxiliar nos testes, recomendamos usar o Postman com a nossa coleção e consultar a documentação completa.
-
Coleção Postman: https://app.getpostman.com/run-collection/5d43ba6b3834eb9f5c66
-
Central de Conhecimento API: https://ajuda.d4sign.com.br/integra%C3%A7%C3%B5es-via-api-e-sso
Códigos de Resposta (Status Code)
-
200 OK: A requisição foi processada com sucesso.
-
400 Bad Request: A requisição enviada contém um erro. O problema está na sua solicitação (por exemplo, dados incorretos no
body
). Verifique a documentação para corrigir os parâmetros. -
500 Internal Server Error: Este erro indica um problema interno em nossos servidores. Embora seja raro, a mensagem de retorno será
{"message": "Server error."}
.
Erros de Requisição Comuns
-
"Esta chave da API já atingiu o tempo limite para este método"
-
Motivo: Sua chave de API atingiu o limite de requisições por hora para o método utilizado.
-
Solução: Entre em contato com comercial@d4sign.com.br para verificar a possibilidade de aumentar seu limite. Se você já tem um plano com limite elevado, confirme se está usando a chave da conta correta.
-
-
"file empty" (arquivo vazio)
-
Motivo: Erro de upload. Geralmente ocorre quando o arquivo referenciado no
body
da requisição não foi encontrado no seu dispositivo ou o caminho está incorreto.
-
-
"message": null (400 - bad request)
-
Motivo: Erro genérico de
bad request
, que muitas vezes acontece quando obody
da requisição está incorreto (por exemplo, um ID de template inválido). -
Solução: Revise o
body
da sua requisição, conferindo se todos os IDs e parâmetros estão corretos, conforme a documentação.
-
-
"This account has no more limits to send documents"
-
Motivo: A sua conta excedeu o limite de envios de documentos.
-
Solução: Entre em contato com comercial@d4sign.com.br para adquirir mais envios. Se você possui um plano e os envios foram desativados, fale com finance@d4sign.com.br.
-
-
"It is not possible to use the authentication point 'certificadoicpbr' for your region"
-
Motivo: A requisição para assinatura com certificado digital está sendo feita de fora do Brasil ou com uma VPN ativada.
-
Solução: É necessário realizar o processo em um ambiente localizado no Brasil para que a autenticação ICP-Brasil funcione corretamente.
-
-
Falha ao receber notificações Webhook (Erro 500 ou 0)
-
Motivo: Seu servidor não está aceitando as notificações enviadas pela D4Sign.
-
Solução: Inclua os seguintes IPs na
whitelist
(lista de permissões) do seu servidor para que ele possa receber as notificações do nosso webhook:-
52.5.142.59
-
34.226.132.221
-
52.54.43.157
-
54.207.61.120
-
18.228.91.93
-
18.228.174.47
-
-
-
"Chave de API inválida" (401 - Unauthorized)
-
Motivo:
{"message":"API error: Check API user.","mensagem_pt":"Chave de API inválida."}
. A chave de API ou acryptKey
estão incorretas. -
Solução: Verifique os seguintes pontos: a chave foi digitada corretamente? A
cryptKey
está presente na requisição? Há espaços em branco antes ou depois das chaves? Você está usando a chave do ambiente de produção nosandbox
ou vice-versa?
-
-
"not permission this safe"
-
Motivo: O token de API e a
cryptKey
da conta que faz a requisição não têm permissão para acessar o cofre (UUID
) especificado. -
Solução: Verifique se a conta de API tem acesso ao cofre compartilhado ou se o
UUID
do cofre está correto.
-
-
"false - metodo desconhecido"
-
Motivo: A URL da requisição (
request
) está incorreta e o endpoint solicitado não existe. -
Solução: Revise a URL para garantir que ela corresponde exatamente ao formato da nossa documentação.
-
-
body
retorna vazio (código 200)-
Motivo (Sandbox): Em algumas requisições no ambiente de testes, é normal receber um retorno vazio, mas o upload do documento pode ter sido feito com sucesso. Verifique se o documento foi criado.
-
Motivo (Produção): Se isso ocorrer no ambiente de produção, pode ser um erro de formatação da requisição. Verifique se os IDs e os valores no
body
estão corretos e se a requisição foi estruturada conforme a documentação.
-
-
Lentidão na requisição
-
Motivo: Pode ser um problema na sua conexão de rede, VPN, firewall ou dispositivo.
-
Solução: Teste a requisição em outro ambiente, sem VPN ou em outro dispositivo, para isolar a causa do problema.
-