Códigos HTTP das respostas

Nossas APIs utilizam respostas HTTP convencionais para indicar sucesso ou falha nas requisições. Respostas com status 2xx indicam sucesso, status 4xx indicam falhas decorrentes de erros nas informações enviadas, e status 5xx indicam falhas decorrentes de problemas internos ou de infraestrutura.

TIP

A tabela a seguir lista os códigos de resposta HTTP utilizados em nossas APIs:

Código HTTP	Descrição
200 OK	Sua requisição foi bem sucedida.
201 Created	A requisição foi bem sucedida e um recurso foi criado como resultado.
400 Bad Request	Algum parâmetro obrigatório não foi enviado ou é inválido. Neste caso a própria resposta indicará qual é o problema.
401 Unauthorized	Não foi enviada uma chave de API ou ela é inválida, ou você não tem permissão para acessar esse recurso
404 Not Found	O endpoint ou o objeto solicitado não existe.
500 Internal Server Error	Uma falha inesperada ocorreu no servidor da Nextcode. Por segurança, os detalhes serão ofuscados

🚧 Atenção!

O código 200 não significa um resultado positivo, por exemplo, que encontramos um documento na classificação, significa apenas que a análise em ocorreu com sucesso sem erros internos. Para identificar quais informações foram possíveis ser extraídas, observe diretamente o campo equivalente no objeto de resposta da requisição.

Tarifação

Para tarifarmos de forma fácil e transparente, siplificamos ao máximo o sistema de tarifação, e este ocorrerá da seguinte forma:

• Respostas com código HTTP 2xx, serão tarifados;

• Respostas com código HTTP diferente de 2xx, não serão tarifados;

Exemplos:

1. Uma análise de classificação onde não tenha sido encontrada um documento (um arquivo em branco ou de péssima resolução) irá retornar 200 porém, com a lista de documentos vazia. Esse cenário irá gerar cobrança, pois houve o processamento.

2. Uma análise onde o documento havia boa resolução mas por algum motivo durante a análise houve algum erro de processamento, a resposta será um 500. Esse cenário não irá gerar cobrança pois não se concluiu o processamento.

3. Uma chamada com problemas de autenticação que tenha retornado um 4xx. Não irá gerar cobrança pois não houve o processamento.

4. Para SDKs, a tarifação ocorrerá nas chamadas ao backend, o uso em sí do SDK não acarretará cobranças, apenas por request enviada, seguindo o mesmo padrão das demais requests.