Erros

Todos os erros devolverão o código de resposta HTTP mais específico e apropriado da tabela seguinte:

Códigos de retorno

Código	Erro	Descrição
400	Pedido inválido	Foi recebido do cliente um pedido malformado. Esta é a resposta mais genérica dada pela API
401	Não autorizado	Não está autorizado e não pode aceder ao recurso solicitado
403	Proibido	Não tem permissão para aceder ao recurso solicitado
404	Não encontrado	O recurso solicitado não pode ser encontrado. Poderá ficar disponível mais tarde
405	Método não permitido	Foi usado um método HTTP não suportado para o recurso solicitado
406	Não aceitável	O tipo Accept ou Accept-Encoding solicitado pelo cliente não está disponível
409	Conflito	O pedido não pode ser concluído porque existe um conflito com o recurso existente
410	Já não disponível	O recurso solicitado já não está disponível e nunca estará no futuro
411	Comprimento necessário	O recurso solicitado espera que o cliente forneça um Content-Length
413	Entidade do pedido demasiado grande	O corpo do pedido fornecido pelo cliente era demasiado grande; o recurso recusa-se a processá-lo
415	Tipo de media não suportado	Foi fornecido pelo cliente um Content-Type incorreto (ou nenhum)
422	Entidade não processável	O pedido não está malformado e o tipo de media é aceitável, mas o recurso não consegue processar o pedido
429	Demasiados pedidos	O limite de taxa foi atingido. Consulte a secção de limitação de taxa para mais informações
500	Erro interno do servidor	O servidor não pôde processar o seu pedido devido a um erro interno inesperado
501	Não implementado	O recurso solicitado não foi implementado
503	Serviço indisponível	O serviço solicitado não está temporariamente disponível

Formato padrão da resposta

Todos os erros terão um corpo de resposta padrão com dois campos, código e mensagem. Podem ser usados mais campos, mas são opcionais.

Exemplos

Esta é a forma mais simples do corpo de resposta de um erro; os clientes podem confiar que estes campos estarão presentes em todos os erros.

Respostas de erro - Exemplo 1 (Base)

{
  "code": 429,
  "message": "Excedeu o seu número de pedidos. Tente novamente mais tarde"
}

O exemplo seguinte tem, além dos campos padrão, campos para erros associados a este pedido específico.

Respostas de erro - Exemplo 2 (Mais complexo)

{
  "code": 422,
  "message": "Entidade não processável",
  "cause": "A validação falhou",
  "errors": [
    {
      "resource": "Issue",
      "field": "title",
      "code": "missing_field"
    },
    ...
  ]
}