Códigos HTTP da API

A API Vindi possui um padrão bem estabelecido de retornos para códigos HTTP. A documentação da API determina quais são os retornos possíveis para cada método, porém todos eles respeitam o seguinte padrão:

Código Nome Descrição
200 OK O recurso solicitado foi processado e retornado com sucesso.
201 Created O recurso informado foi criado com sucesso.
401 Unauthorized A chave da API está desativada, incorreta ou não foi informada corretamente. Consulte a seção sobre autenticação da documentação.
404 Not Found O recurso solicitado ou o endpoint não foi encontrado.
406 Not Acceptable O formato enviado não é aceito. O cabeçalho Content-Type da requisição deve contar obrigatoriamente o valor application/json para requisições do tipo POST e PUT.
422 Unprocessable Entity A requisição foi recebida com sucesso, porém contém parâmetros inválidos. Para mais detalhes, verifique o atributo errors no corpo da resposta.
429 Too Many Requests O limite de requisições foi atingido. Verifique o cabeçalho Retry-After para obter o tempo de espera (em segundos) necessário para a retentativa.
400 Bad Request Não foi possível interpretar a requisição. Verifique a sintaxe das informações enviadas.
500 Internal Server Error Ocorreu uma falha na plataforma Vindi. Por favor, entre em contato com o atendimento.

Nomes e códigos seguem a RFC 2616 do IETF.

Observações:

  • Métodos usados para buscas (GET /customers, por exemplo) retornam o código 200 mesmo que nenhum recurso tenha sido encontrado. Neste caso, o corpo da resposta conterá um array vazio.
  • Requisições do tipo DELETE e PUT retornam o código 200 se forem processadas com sucesso.

 

Tem mais dúvidas? Envie uma solicitação

Comentários

Powered by Zendesk