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

# Introdução

> Documentação da API pública do Synax para integrações externas

# API Synax

Bem-vindo à documentação da API do **Synax**. Aqui você encontra tudo o que precisa para integrar seu sistema com a plataforma.

## Base URL

```
https://api.synax.app.br/functions/v1/api-proxy
```

## Autenticação

Todas as requisições usam **API Keys**. Gere sua chave em **Configurações > API** no app.

```bash theme={null}
curl "https://api.synax.app.br/functions/v1/api-proxy/contacts" \
  -H "Authorization: Bearer sk_live_SuaChaveAqui"
```

## O que você pode fazer

<CardGroup cols={2}>
  <Card title="Contatos" icon="address-book" href="/guides/contacts">
    Criar, listar, atualizar e excluir contatos do CRM
  </Card>

  <Card title="Conversas" icon="comments" href="/guides/conversations">
    Consultar conversas do chat e gerenciar status
  </Card>

  <Card title="Mensagens" icon="message" href="/guides/messages">
    Consultar histórico de mensagens
  </Card>

  <Card title="Negócios" icon="handshake" href="/guides/deals">
    Gerenciar deals no pipeline de vendas
  </Card>

  <Card title="Campanhas" icon="bullhorn" href="/guides/campaigns">
    Acompanhar campanhas de disparo
  </Card>

  <Card title="Webhooks" icon="bell" href="/guides/webhooks">
    Receber notificações em tempo real
  </Card>
</CardGroup>

## Recursos disponíveis

| Recurso   | Endpoint                   | Métodos                  |
| --------- | -------------------------- | ------------------------ |
| Contatos  | `/api-proxy/contacts`      | GET, POST, PATCH, DELETE |
| Conversas | `/api-proxy/conversations` | GET, PATCH               |
| Mensagens | `/api-proxy/messages`      | GET                      |
| Negócios  | `/api-proxy/deals`         | GET, POST, PATCH         |
| Pipelines | `/api-proxy/pipelines`     | GET                      |
| Estágios  | `/api-proxy/stages`        | GET                      |
| Campanhas | `/api-proxy/campaigns`     | GET                      |
| Disparos  | `/api-proxy/dispatches`    | GET                      |

## Início rápido

<Steps>
  <Step title="Crie sua API Key">
    No app, vá em **Configurações > API** e clique em **Nova chave**.
  </Step>

  <Step title="Faça sua primeira requisição">
    [Liste seus contatos](/guides/contacts) para validar a integração.
  </Step>

  <Step title="Configure webhooks">
    [Receba eventos](/guides/webhooks) em tempo real via Supabase Realtime.
  </Step>
</Steps>