Códigos de retorno (HTTP status)

A SkyHub 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 incorretos, ausência de um campo obrigatório, etc;

  • Códigos HTTP 5xx: indicam algum erro nos servidores da SkyHub. Esses são raros e, caso você receba esse código, você deve entrar em contato com o nosso suporte.

Erros

Sempre que ocorrer um erro, a API retornará no corpo (body) da mensagem um JSON com uma mensagem de erro de acordo com o formato abaixo:

{error: "mensagem de erro"}

Status HTTP

Os status HTTP mais utilizados 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 o cabeçalho (header) da requisição o e-mail e o token

403

Não autorizado - você está tentando acessar um recurso ao 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 pode ser processada