These docs are for v1.0. Click to read the latest docs for v3.0.

Mensagens de erro

Códigos de erros e explicações

A Clicksign segue o padrão de HTTP Status Codes. Os erros 4xx ocorrem quando há algo de errado na requisição que o cliente está enviando para a Clicksign. Já os erros 5xx, são erros inesperados que ocorrem nos servidores da Clicksign.

4×× Client Error

❗️

Sempre verifique o BODY da resposta.

O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign.

🚧

Erro de CORS (Cross-Origin Resource Sharing)

As requisições devem ser efetuadas via server-side. Via browser irá falhar, com retorno de 404.

CódigoReferênciaExplicação
400BAD REQUESTO servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico.
401UNAUTHORIZEDO servidor não autorizou a requisição. Access Token inválido.
403FORBIDDENO servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso.
404NOT FOUNDO servidor não encontrou o recurso ou não está disposto a divulgar sua existência.
422UNPROCESSABLE ENTITYO servidor não conseguiu processar as informações contidas na requisição.

Exemplo de retorno de requisição inválida

{
    "errors": [
        "Campo obrigatório send_email não está presente em um ou mais signatários."
    ]
}

5×× Server Error

CódigoReferênciaExplicação
500INTERNAL SERVER ERROROcorreu um erro interno inesperado.

A Clicksign possui sistema de monitoramento de erros 500.

Suporte da Clicksign

Se você estiver com problemas relacionados à integração, entre em contato conosco através do e-mail [email protected] com o máximo de detalhes possível. Informações que nos ajudam a debugar a sua requisição:

- Ambiente: sandbox ou produção
- Conta
- E-mail do operador
- Path da requisição
- Método da requisição
- Código HTTP de erro
- JSON enviado
- JSON recebido
- Key do documento
- E-mails contidos na lista de assinatura
- Horário da requisição
- IP de origem
- Print screen.