Códigos de resposta

Respostas HTTP

A API utiliza códigos de status HTTP para indicar o resultado de cada requisição.

Os códigos disponíveis podem variar conforme o endpoint. Consulte sempre a seção Responses da operação utilizada.

Código	Significado	Orientação
`200`	Requisição processada com sucesso	Continue o processamento da resposta
`204`	Processada sem conteúdo de retorno	Não espere um corpo JSON
`400`	Dados ou parâmetros inválidos	Revise os campos e parâmetros enviados
`401`	Token ausente ou inválido	Confira o cabeçalho `Authorization`
`404`	Recurso não encontrado	Confira a URL e os identificadores informados
`429`	Limite temporário de requisições	Aguarde antes de tentar novamente
`500`	Erro interno no processamento	Registre os dados da chamada e acione o suporte

Respostas de sucesso

200 — OK

A requisição foi processada e a resposta pode conter um objeto, uma lista ou informações de paginação.

HTTP 200 OK
Content-Type: application/json

204 — Sem conteúdo

A operação foi concluída, mas não existe conteúdo para retornar.

HTTP 204 No Content

Erros na requisição

400 — Requisição inválida

Pode ocorrer quando:

Um campo obrigatório não foi enviado;
Um parâmetro possui formato inválido;
O corpo JSON está incorreto;
Um valor não é aceito pelo endpoint.

Antes de repetir a chamada, revise os parâmetros e o corpo da requisição.

401 — Não autorizado

Verifique se o cabeçalho foi enviado corretamente:

Authorization: Bearer SEU_TOKEN_DE_INTEGRACAO

Também confirme se o token pertence à conta correta e possui acesso ao recurso solicitado.

404 — Não encontrado

Confira:

O endereço do endpoint;
A versão utilizada;
Os identificadores enviados na URL;
Se o registro ainda existe.

429 — Limite excedido

Reduza a frequência das chamadas e aguarde antes de tentar novamente. Em integrações automatizadas, implemente novas tentativas com intervalo progressivo.

500 — Erro interno

O servidor não conseguiu concluir o processamento.

Evite repetir continuamente a mesma chamada. Registre as informações da requisição e, se o erro persistir, entre em contato com o suporte.

Boas práticas

Trate os códigos de sucesso e erro separadamente;
Não considere toda resposta HTTP como bem-sucedida;
Registre data, horário, endpoint, método e código retornado;
Implemente tentativas automáticas somente quando apropriado;
Nunca registre ou compartilhe o token de integração.

Ao solicitar suporte

Informe:

Nome da empresa;
Endpoint e método HTTP;
Horário aproximado da chamada;
Código HTTP retornado;
Corpo da resposta de erro;
Resultado esperado.

Remova tokens, senhas, dados pessoais e outras informações sensíveis antes de enviar exemplos ou registros.