> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ar-online.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão geral da API

> Referência técnica da API da AR Online: base URL, autenticação, formato e principais endpoints.

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:

```
https://api.ar-online.com.br
```

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`.

```bash theme={null}
curl https://api.ar-online.com.br/gw/email \
  -H "Authorization: SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json"
```

O token de produção é solicitado ao suporte ([suporte@ar-online.com.br](mailto:suporte@ar-online.com.br)). Veja os detalhes em [Autenticação](/autenticacao).

## 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](/referencia/rate-limit) e as [mensagens de erro](/referencia/erros).

## Principais endpoints

| Método | Endpoint                                 | Descrição                                                           |
| ------ | ---------------------------------------- | ------------------------------------------------------------------- |
| POST   | `/gw/email`                              | Envio de AR (e-mail e canais combinados: SMS, WhatsApp, Voz, Carta) |
| GET    | `/gw/full/{idEmail}`                     | Status consolidado de todos os canais (dados de perícia)            |
| GET    | `/gw/email/{idEmail}`                    | Status do AR-Email                                                  |
| GET    | `/gw/sms/{idEmail}`                      | Status do AR-SMS                                                    |
| GET    | `/gw/whatsapp/{idEmail}`                 | Status do AR-WhatsApp                                               |
| GET    | `/gw/voz/{idEmail}`                      | Status do AR-Voz                                                    |
| GET    | `/gw/carta/{idEmail}`                    | Status do AR-Cartas                                                 |
| GET    | `/gw/sending-proof/{idEmail}`            | Comprovante de envio (PDF em base64)                                |
| GET    | `/gw/email/laudo/{idEmail}`              | Laudo pericial (arquivo PDF binário)                                |
| GET    | `/regua-notificacao/finalizar/{idEmail}` | Finaliza a régua de notificação                                     |
| GET    | `/gw/templates`                          | Lista os templates do usuário                                       |
| GET    | `/gw/templates/{id}`                     | Busca um template específico                                        |
| PUT    | `/gw/templates/{id}`                     | Edita nome e compartilhamento do template                           |
| PATCH  | `/gw/templates/{id}/status`              | Ativa ou desativa um template                                       |
| DELETE | `/gw/templates/{id}`                     | Desativa um template (soft delete)                                  |

<CardGroup cols={2}>
  <Card title="Rate limit" href="/referencia/rate-limit" icon="gauge-high">
    Limites de taxa por endpoint e como cadastrar seu IP na whitelist.
  </Card>

  <Card title="Mensagens de erro" href="/referencia/erros" icon="triangle-exclamation">
    Códigos HTTP, mensagens e como resolver cada erro.
  </Card>
</CardGroup>