Skip to main content
Esta seção reúne a referência técnica da API da AR Online. Aqui você encontra as informações transversais a todos os endpoints (base URL, autenticação, formato de dados e fusos) e os links para a política de rate limit e a lista de mensagens de erro.

​
Base URL

Todas as chamadas usam a base URL:
Os endpoints públicos ficam sob o prefixo /gw/ (por exemplo, POST /gw/email). A única exceção é a finalização da régua de notificação, que fica fora desse prefixo: GET /regua-notificacao/finalizar/{idEmail}.

​
Autenticação

Toda requisição precisa enviar o token JWT no cabeçalho Authorization, sem o prefixo Bearer, e o Content-Type como application/json.
O token de produção é solicitado ao suporte (suporte@ar-online.com.br). Veja os detalhes em Autenticação.

​
Formato e fusos

  • Formato de dados: requisições e respostas em JSON (Content-Type: application/json).
  • Datas: todas as datas retornadas pela API estão no fuso BRT (horário de Brasília).
  • Envio assíncrono: um POST /gw/email bem-sucedido retorna HTTP 200 com { "idEmail": "..." }, o que significa “aceito para processamento” — e não “entregue”. Use os endpoints de consulta de status para acompanhar a entrega.

​
Endpoints interativos

Os endpoints com “experimente agora” (gerados a partir da especificação OpenAPI) estão no grupo Endpoints da navegação. Use esta seção de referência para entender o comportamento geral, a política de rate limit e as mensagens de erro.

​
Principais endpoints

Rate limit

Limites de taxa por endpoint e como cadastrar seu IP na whitelist.

Mensagens de erro

Códigos HTTP, mensagens e como resolver cada erro.