Mensagens de resposta

Informações sobre os diversos erros e mensagens de resposta que as interfaces de programação de aplicativos (APIs) do Verify retornam.

Os códigos de status HTTP indicam se uma operação foi bem-sucedida ou não. Os seguintes tipos de erros podem ser retornados ao enviar solicitações e receber respostas das Verify APIs:
Sucesso 2xx
Indica o status de sucesso da operação.
Erros de cliente 4xx
Indica um problema com a solicitação que o aplicativo cliente enviou. Corrija o problema na solicitação antes de reenviar a solicitação.
Erros do servidor 5xx
Indica um problema com o servidor. Reenvie ou tente novamente a solicitação até que ela seja bem-sucedida.
O corpo da resposta contém um identificador de mensagem (messageId) e o texto que é traduzido para o código do idioma do solicitante (messageDescription).
Tabela 1. Mensagens de resposta
Código de Status HTTP Descrição
200 Recuperação bem-sucedida de um objeto
201 Criação bem-sucedida de um objeto
202 A solicitação foi aceita, mas não concluída (operação assíncrona).
204 A operação solicitada, como atualização ou exclusão de um objeto, foi bem-sucedida.
207 Múltiplos status - uma combinação de resultados foi retornada. Esse status pode ocorrer com operações PATCH e em massa.
400 Solicitação inválida. A solicitação foi malformada ou não pode ser manipulada. Os parâmetros de entrada podem conter valores inválidos.
401 O cliente não foi autenticado. Por exemplo, o token de acesso que é usado não é válido.
403 Acesso Proibido. Por exemplo, o token de acesso não permite acesso ao recurso solicitado.
404 Recurso não foi localizado. As informações solicitadas não existem.
405 O método de HTTP que é especificado na solicitação não é suportado pelo recurso.
406 O recurso não pode produzir a representação que é especificada no cabeçalho Accept da solicitação.
409 As informações existem.
415 O recurso não pode consumir a representação que é especificada no cabeçalho Content-Type da solicitação.
429 Muitas solicitações
500 Ocorreu um erro interno do servidor ao processar a solicitação.
501 O método solicitado foi desativado.
502 A notificação não foi enviada.
Se todas as operações forem bem-sucedidas durante as operações PATCH, um status
204
será retornado. Se houver uma ou mais falhas, um status 207 será retornado e o cliente poderá analisar os resultados.
Se todas as operações forem bem-sucedidas durante operações de gerenciamento em massa como POST ou DELETE, um status
201
será retornado. Se houver uma ou mais falhas, um status 207 será retornado e o cliente poderá analisar os resultados.

Para manipulação de erros, use o código de resposta HTTP e messageId no corpo de resposta de erro. O messageDescription deve ser usado somente para informações e está sujeito a mudanças. Qualquer uma dessas mudanças não constitui mudança na semântica da API.