Códigos de retorno (HTTP status)
Neste tópico são apresentados os possíveis códigos de retorno na API e a mensagem que será visualizada, seja em caso de sucesso ou de erro
A API da Americanas utiliza o grupo padrão dos status HTTP para indicar se uma requisição teve sucesso ou não. No geral:
Códigos HTTP 2XX indicam que a requisição foi realizada com sucesso;
Códigos HTTP 4XX indicam que a requisição contém alguma informação incorreta - dados de acesso, ausência de um campo obrigatório, entre outros;
Códigos HTTP 5XX indicam algum erro nos servidores da API. Esses são raros e caso receba esse código, deve entrar em contato com o nosso suporte.
Status HTTP
Os status HTTP mais comuns são:
Status | Descrição |
200 | Sucesso (A requisição foi processada com sucesso) |
201 | Criado (A requisição foi processada com sucesso e resultou em um novo recurso criado) |
204 | Sem conteúdo (A requisição foi processada com sucesso e não existe conteúdo adicional na resposta) |
400 | Requisição mal formada (A requisição não está de acordo com o formato esperado. Verifique o JSON (body) que está sendo enviado) |
401 | Não autenticado (Os dados de autenticação estão incorretos. Verifique no cabeçalho (header) da requisição o e-mail e o token) |
403 | Não autorizado (Você está tentando acessar um recurso para o qual não tem permissão) |
404 | Não encontrado (Você está tentando acessar um recurso que não existe na SkyHub) |
406 | Formato não aceito (A SkyHub não suporta o formato de dados especificado no cabeçalho (Accept)) |
415 | Formato de mídia não aceito (A SkyHub não consegue processar os dados enviados por conta de seu formato. Certifique-se do uso do charset UTF-8 (tanto no header "Content-Type", quanto no próprio body da requisição)) |
422 | Erro semântico (Apesar do formato da requisição estar correto, os dados ferem alguma regra de negócio (por exemplo: transição inválida do status de pedido)) |
429 | Limite de requisições ultrapassado (Você fez mais requisições do que o permitido em um determinado recurso) |
500 ou 502 | Erro interno (Ocorreu um erro no servidor da SkyHub ao tentar processar a requisição) |
503 | Serviço indisponível (A API da SkyHub está temporariamente fora do ar) |
504 | Timeout (A requisição levou muito tempo e não pôde ser processada) |
Erros
Sempre que ocorrer um erro, a API retornará no corpo (body) da mensagem um JSON de acordo com o formato abaixo:
A tratativa dos erros recebidos é imprescindível para a fluidez do fluxo de integração.
Navegue pelo nosso guia Consulta de Erros para maiores detalhes sobre a visualização dos erros de integração.
Last updated