> ## Documentation Index
> Fetch the complete documentation index at: https://devs.izap.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API REST

> A API HTTP da iZap — recursos, convenções e modelo de erros.

A API REST da iZap tem raiz em `/api/v1` em cada ambiente e é autenticada com
OAuth 2.0 / JWT (veja [Autenticação](/pt/api-reference/authentication)). Explore o
schema completo de requisição e resposta — e faça chamadas ao vivo — na seção
**Endpoints** desta aba.

| Ambiente | Origem                        |
| -------- | ----------------------------- |
| Produção | `https://api.izap.ai`         |
| Staging  | `https://api-staging.izap.ai` |

<Tip>
  Novo na iZap? O [assistente de configuração](/pt/api-reference/wizard) monta um
  cliente funcional (REST, MCP, webhooks ou SSE) na sua stack com um único comando.
</Tip>

## Recursos

| Recurso               | Caminho                        | Finalidade                                    |
| --------------------- | ------------------------------ | --------------------------------------------- |
| Auth                  | `/api/v1/auth/*`, `/oauth/*`   | Login com JWT e OAuth 2.0                     |
| Empresas              | `/api/v1/businesses/*`         | Configuração de tenant e membros              |
| Chats                 | `/api/v1/chats/*`              | Leitura/escrita de conversas e envio          |
| Agendamento           | `/api/v1/scheduling/*`         | Clientes, serviços e reservas                 |
| Templates de WhatsApp | `/api/v1/whatsapp_templates/*` | Gerenciar e sincronizar templates de mensagem |
| Transmissões          | `/api/v1/transmissions/*`      | Transmissões (broadcasts) de WhatsApp         |

## Convenções

* **Versionamento** — a API está montada sob `/api/v1`; mudanças que quebram
  compatibilidade migram para um novo caminho de versão.
* **Auth** — envie `Authorization: Bearer <jwt>` em cada requisição.
* **Content type** — corpos de requisição e resposta em JSON, exceto na
  autenticação, que usa form-encoded.

## Status

Verifique a saúde da plataforma em tempo real na [página de status](https://api.izap.ai/status).
O endpoint `/health` permanece disponível como uma sonda de disponibilidade em
JSON, legível por máquina, para seu próprio monitoramento.

## Modelo de erros

| Status | Significado                                          |
| ------ | ---------------------------------------------------- |
| `401`  | Token ausente/expirado — reautentique-se.            |
| `422`  | Erro de validação — verifique o corpo da requisição. |
| `400`  | Conflito de domínio ou de dados.                     |
| `500`  | Erro de servidor.                                    |