Respostas
A API normalmente retorna JSON no corpo da resposta.
Alguns endpoints não retornam JSON, apenas o código de status HTTP.
Códigos de status de resposta
A API utiliza os seguintes códigos HTTP, conforme definido na RFC 2616 e na RFC 6585:
| Código | Status | Descrição |
|---|---|---|
| 200 | OK | A requisição foi bem-sucedida. O cliente pode ler o resultado no corpo e nos cabeçalhos da resposta. |
| 201 | Created | A requisição foi concluída e resultou na criação de um novo recurso. |
| 202 | Accepted | A requisição foi aceita para processamento, mas o processamento ainda não foi concluído. |
| 204 | No content | A requisição foi bem-sucedida, mas não retorna conteúdo no corpo da mensagem. |
| 304 | Not modified | Não modificado. Consulte requisições condicionais. |
| 400 | Bad request | A requisição não pôde ser entendida devido à sintaxe incorreta. O corpo da resposta pode conter mais detalhes. |
| 401 | Unauthorized | A requisição requer autenticação ou as credenciais fornecidas foram recusadas. |
| 403 | Forbidden | O servidor entendeu a requisição, mas recusou-se a atendê-la. |
| 404 | Not found | O recurso solicitado não foi encontrado (temporário ou permanente). |
| 429 | Too many requests | O limite de requisições foi excedido. |
| 500 | Internal server error | Erro interno inesperado. Se ocorrer, informe-nos. |
| 502 | Bad gateway | O servidor atuou como gateway e recebeu resposta inválida do upstream. |
| 503 | Service unavailable | O servidor está temporariamente indisponível. Tente novamente mais tarde. |
Próximos passos
Conheça as jornadas de uso para a integração com o NDD Cargo.