Padrões das APIs REST

As APIs do Tax360 seguem a arquitetura REST e são acessadas via protocolo HTTP. Todas as respostas, incluindo erros, são retornadas em formato JSON.

Visão Geral

As APIs do Tax360 seguem a arquitetura REST e são acessadas via protocolo HTTP. Todas as respostas, incluindo erros, são retornadas em formato JSON.

Todas as requisições exigem um token JWT, obtido a partir de uma chave de API criada por um usuário administrador no portal IAM.

O token deve ser enviado no header HTTP Authorization com o esquema Bearer:

Authorization: Bearer <seu_token_jwt>

Todos os endpoints aceitam o header Accept-Language para controlar o idioma das mensagens de retorno.

Valor	Idioma
`pt-BR`	Português (Brasil)
`en-US`	Inglês (Estados Unidos)

Serviço	URL
IAM	`https://<API_HOST>/`
DF-e	`https://<API_HOST>/`

Com exceção do endpoint de geração de token, todos os endpoints retornam um JSON no seguinte formato:

{
  "code": "SUCCESS",
  "message": "Mensagem",
  "data": null,
  "success": true
}

Campo	Tipo	Obrigatório	Descrição
`success`	`boolean`	Sim	Indica se a operação teve sucesso. Valores: `true` ou `false`.
`code`	`string`	Sim	Código da operação. `SUCCESS` para sucesso; outros valores dependem do contexto do endpoint.
`message`	`string`	Não	Mensagem legível que pode ser exibida diretamente ao usuário final. Para mensagens customizadas, inspecione o campo `code`.
`data`	`object \| array \| null`	Não	Payload de retorno. O conteúdo varia por endpoint — pode ser um objeto, um array de objetos, um ID, ou `null`.

Código	Uso
`200`	Operação concluída com sucesso (padrão).
`202`	Operação assíncrona iniciada; será concluída posteriormente.
`204`	Exclusão realizada com sucesso.

Código	Significado	Ação recomendada
`400`	Erro de validação de dados ou regra de negócio.	Exibir `message` ao usuário ou inspecionar `code` para mensagem customizada.
`401`	Token inválido ou expirado.	Gerar novo token via IAM.
`403`	Permissão negada.	Verificar se a chave de API possui as permissões necessárias para a operação.
`500`	Erro interno do servidor.	Realizar nova tentativa. Se persistir, exibir mensagem ao usuário e contatar o suporte.