Mensagens de erro

📘
Esta é a segunda versão da documentação de API da Clicksign, que inclui o uso de envelopes via API. Envelopes são uma forma de agrupar documentos e signatários em uma única entidade, facilitando o gerenciamento e a assinatura de documentos. Caso queira consultar a versão anterior da documentação de API, que não usa envelopes, clique aqui. Caso tenha alguma dúvida ou sugestão, entre em contato com [email protected].

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.

Sobre as mensagens de erro

Seguindo a especificação JSONAPI, todas mensagens de erro terão detalhes do erro no corpo da resposta, nesse informaremos code, status, title, detail e (quando necessário) source.

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ódigo	Referência	Explicação
400	BAD REQUEST	O servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico.
401	UNAUTHORIZED	O servidor não autorizou a requisição. Access Token inválido.
403	FORBIDDEN	O servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso.
404	NOT FOUND	O servidor não encontrou o recurso ou não está disposto a divulgar sua existência.
422	UNPROCESSABLE ENTITY	O servidor não conseguiu processar as informações contidas na requisição.

Exemplos de retorno de requisição inválida

{
	"errors": [
		{
			"code": "bad_request",
			"status": 400,
			"source": {
				"pointer": "/data/attributes/filename"
			},
			"detail": "filename deve ser informado(a)"
		}
	]
}

{
	"errors": [
		{
			"code": "unauthorized",
			"status": 401,
			"title": "Não autorizado",
			"detail": "Access Token inválido"
		}
	]
}

5×× Server Error

Código	Referência	Explicação
500	INTERNAL SERVER ERROR	Ocorreu 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