Antes de começar a integrar, vale entender alguns conceitos que aparecem em toda a API da AR Online.
idEmail: o identificador de rastreio
Todo envio bem-sucedido retorna um idEmail — um identificador único (UUID) gerado pela plataforma:
Esse é o identificador de rastreio do envio. Guarde-o: é com ele que você consulta o status de cada canal (e-mail, SMS, WhatsApp, voz e carta), obtém comprovantes e laudos.
Você também pode informar um customID no envio — uma referência externa sua (por exemplo, o ID do registro no seu sistema) para correlacionar com seus próprios registros.
HTTP 200 significa “aceito”, não “entregue”
O envio é assíncrono. Quando a API responde HTTP 200 com o idEmail, isso significa que a requisição foi aceita para processamento — e não que a mensagem já foi entregue.
HTTP 200 não é confirmação de entrega. A entrega acontece em segundo plano, após a resposta. Para saber se a mensagem foi efetivamente enviada, entregue ou lida, você precisa consultar o status ou receber as atualizações via webhook.O prefixo público /gw/
Os endpoints públicos da API usam o prefixo /gw/. A base é:
Assim, o envio é feito em POST https://api.ar-online.com.br/gw/email, a consulta de status do e-mail em GET /gw/email/{idEmail}, e assim por diante.
Há uma exceção: o endpoint de finalização de régua de notificação não usa o prefixo /gw/ (GET /regua-notificacao/finalizar/{idEmail}).
Datas no fuso de Brasília (BRT)
Todas as datas retornadas pela API estão no fuso horário BRT (horário de Brasília). Considere isso ao exibir ou comparar timestamps na sua aplicação. 
