Respostas de erro comunsAll Versions

400 - Bad Request (Solicitação inválida)

Retorna se sua solicitação estiver corrompida ou contiver valores impróprios. O corpo da resposta indicará o nome do campo incorreto, seu tipo e o valor do serviço recebido. Esse formato é usado por todos os serviços e método na nova API.

Exemplo de respostas 

Idioma não compatível:

{
  "type": "invalid_input",
  "message": "An invalid request was sent in, please check the nested errors for details.",
  "errors": [
    {
      "type": "language.not_supported",
      "message": "Language is not supported. Supported languages are: [de-DE, en-US, es-ES, es-MX, fr-FR, id-ID, it-IT, ja-JP, ko-KR, pt-BR, zh-CN]",
      "fields": [
        {
          "name": "language",
          "type": "querystring",
          "value": "xx-XX"
        }
      ]
    }
  ]
}

Valor ausente da versão:

{
  "type": "version.required",
  "message": "You have not specified a version, the supported versions are: [1, 2]",
  "fields": [
    {
      "name": "version",
      "type": "path",
      "value": "missing"
    }
  ]
} 

Valor inválido da versão:

{
  "type": "version.unsupported",
  "message": "You have requested a version that is not supported, supported versions are: [1, 2]",
  "fields": [
    {
      "name": "version",
      "type": "path",
      "value": "3"
    }
  ]
}

401 - Unauthorized (Não autorizado)

Retorna se seu cabeçalho de Autorização HTTP não for encontrado ou não puder ser analisado. Cada solicitação de qualquer serviço de API da EAN deve incluir o hash SHA-512 sem sal da concatenação de sua Chave de API + segredo compartilhado + carimbo de hora UNIX em segundos. Consulte nossa página autorização de assinatura para saber informações completas.

Exemplo de resposta 400 não autorizada:

{
  "type": "request_unauthenticated",
  "message": "Data required to authenticate your request is missing. Ensure that your request follows the guidelines in our documentation."
}

403 - Forbidden (Proibido)

Retorna quando seu cabeçalho de Autorização HTTP é válido, mas você não tem permissão para acessar o recurso solicitado.

Exemplo de resposta 403 proibida:

{
  "type": "request_unauthenticated",
  "message": "Your request could not be authenticated. Ensure that your request follows the guidelines in our documentation.",
  "fields": [
    {
      "name": "apikey",
      "type": "header",
      "value": "jaj3982k239dka328e"
    },
    {
      "name": "signature",
      "type": "header",
      "value": "129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b"
    },
    {
      "name": "timestamp",
      "type": "header",
      "value": 198284729
    },
    {
      "name": "servertimestamp",
      "type": "server",
      "value": 198284729
    }
  ]
}

404 - Not Found (Não encontrado)

Retorna se o recurso da API solicitado não puder ser encontrado. Verifique o URL de sua solicitação em relação aos nossos exemplos documentados. 

A API de geografia e a API de conteúdo também usam respostas 404 para indicar quando arquivos geo ou específicos de conteúdo solicitados ou recursos não podem ser localizados. Consulte as páginas de documentação respectivas para ver exemplos completos.

{
    "type": "resource.not_found",
    "message": "The requested resource could not be found."
}

426 - Upgrade Required (Upgrade necessário)

Retorna se a solicitação não usar TLS (substitui SSL).

{
  "type": "upgrade_required",
  "message": "This service requires the use of TLS."
}

500 - Internal Server Error (Erro de servidor interno)

Retorna um erro dentro da API da EAN ou sistemas de upstream. Tente fazer a solicitação novamente.

{
  "type": "unknown_internal_error",
  "message": "An internal server error has occurred."
}

503 - Service Unavailable (Erro de serviço indisponível)

Retorna se houver um problema técnico com o serviço solicitado. Pode incluir um cabeçalho Recuperar depois para indicar o atraso mínimo (em segundos) antes de tentar novamente.

{
  "type": "service_unavailable",
  "message": "This service is currently unavailable."
}