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

# Visão Geral da API do PanÐá Zap: Endpoints, Autenticação e Limites

> Referência da API REST do PanÐá Zap: estrutura da URL base, autenticação por token Bearer, formato das respostas, códigos de erro, limites e recursos disponíveis.

O PanÐá Zap oferece uma API REST para integração com CRMs, ERPs, plataformas de e-commerce e ferramentas de automação. Através dela você pode enviar e receber mensagens, abrir e atualizar tickets, gerenciar contatos, executar campanhas, consultar análises e muito mais — tudo a partir de qualquer sistema externo.

## URL Base

Todas as rotas da API seguem este padrão:

```text theme={null}
https://{BaseUrl}/v2/api/external/{ApiID}/<resource>
```

| Placeholder | Descrição                                                             |
| ----------- | --------------------------------------------------------------------- |
| `{BaseUrl}` | O domínio do seu servidor PanÐá Zap — sem barra final, sem `https://` |
| `{ApiID}`   | O ID da sua integração de API, encontrado em **Configurações → API**  |

## Autenticação

Toda requisição deve incluir um token Bearer no cabeçalho `Authorization`:

```http theme={null}
Authorization: Bearer YOUR_TOKEN
```

Gere seu token em **Configurações → API → + Nova API**. Consulte a página de [Autenticação](/api/authentication) para instruções completas de configuração.

## Formato da Resposta

Todas as respostas de sucesso retornam um envelope consistente:

```json theme={null}
{
  "success": true,
  "data": { ... }
}
```

Erros retornam:

```json theme={null}
{
  "success": false,
  "error": "ERR_..."
}
```

## Códigos de Status HTTP

| Código | Significado                                                   |
| ------ | ------------------------------------------------------------- |
| `200`  | Sucesso                                                       |
| `400`  | Parâmetros inválidos ou ausentes                              |
| `401`  | Token ausente, inválido ou não autorizado                     |
| `404`  | Recurso não encontrado ou em um estado que rejeita a operação |
| `409`  | Conflito de estado (por exemplo, `ERR_TICKET_CLOSED`)         |

## Códigos de Erro Comuns

* **`ERR_TICKET_CLOSED`** — O ticket de destino está fechado. Envie `"reopen": true` no corpo da sua requisição para reabri-lo antes de enviar.
* **`ERR_NUMBER_AMBIGUOUS`** — Uma busca de contato por número de telefone retornou vários candidatos. Desambigue usando um ID de ticket ou ID de contato.

## Limites e Restrições

* **Corpo JSON com conteúdo base64:** até **50 MB** por requisição.
* **`mediaUrl`:** deve usar `http` ou `https`, não pode redirecionar, e hosts internos/privados são bloqueados.
* **Mesclagem de contatos:** até **150 pares** por requisição.
* **Limite de taxa:** não há limite de taxa nas rotas externas. Use o campo `externalKey` para deduplicar tentativas e evitar operações duplicadas.

## Recursos Disponíveis

<CardGroup cols={2}>
  <Card title="Mensagens" icon="message" href="/api/send-messages">
    Envie mensagens de texto, arquivos e áudio por número de telefone.
  </Card>

  <Card title="Enviar por Ticket" icon="ticket" href="/api/send-by-ticket">
    Envie mensagens via ID de ticket em qualquer canal conectado.
  </Card>

  <Card title="Envio em Massa" icon="paper-plane" href="/api/bulk-send">
    Dispare mensagens em massa para listas de contatos.
  </Card>

  <Card title="Tickets" icon="inbox" href="/api/tickets">
    Crie, atualize e consulte tickets de atendimento.
  </Card>

  <Card title="Contatos" icon="address-book" href="/api/contacts">
    Gerenciamento de contatos do CRM — criar, atualizar, mesclar e buscar.
  </Card>

  <Card title="Campanhas" icon="bullhorn" href="/api/campaigns">
    Gerencie todo o ciclo de vida das campanhas.
  </Card>

  <Card title="CRM" icon="briefcase" href="/api/crm">
    Pipelines, oportunidades e agendamentos.
  </Card>

  <Card title="Métricas do Dashboard" icon="chart-bar" href="/api/authentication#metricas-do-dashboard">
    Consulte contagens de tickets e análises de tempo de resposta para um intervalo de datas.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/api/webhooks">
    Receba eventos em tempo real do PanÐá Zap.
  </Card>
</CardGroup>