A cada requisição enviada via API, você receberá uma resposta, seja com os dados solicitados, ou com informações de erros que podem ter ocorrido durante a requisição. Você receberá um Status Code e uma possível mensagem.
Os Status Code são os códigos que representam o tipo da resposta de uma requisição, abaixo você encontra a explicação para os retornos mais comuns:
200 OK: Retorno padrão para o método GET, onde foi encontrado um recurso ou retornado uma lista de recursos (mesmo se a lista estiver vazia)
201 CREATED: Retorno de sucesso para as requisições POST
202 ACCEPTED: A requisição foi aceita, mas ainda não foi processada
204 NO CONTENT: Retorno padrão para DELETE, PUT e PATCH. Indica que a requisição foi efetuada com sucesso, mas não tem dados para retornar.
400 BAD REQUEST: Erro geral. Por exemplo, um campo obrigatório não enviado ou tentativa de deixar uma entidade em um estado inválido.
401 UNAUTHORIZED: Status para quando o cliente não estiver autenticado. Verifique se usuário e senha estão corretos.
403 FORBIDDEN: A requisição não pode ser processada e não é um problema de autenticação. Normalmente o usuário de API não tem autorização no endpoint.
404 NOT FOUND: O recurso necessitado requisitado não foi encontrado nos métodos (GET, PUT, PATCH, DELETE). Verifique se a URL está montada corretamente conforme a documentação. Erros como “/costumers” ou invés de “/customers” podem gerar esta resposta.
429 TO MANY REQUESTS: Significa que sua requisição não será processada porque atingiu os limites de requisições estipuladas para sua conta. Tanto para limites de segurança (rate limits) como de pacotes de APIs (Start, Special, Essencial, Enterprise, Ultimate).
500 INTERNAL SERVER ERROR: Qualquer exceção não tratada da aplicação irá retornar com status 500