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

# Comece Aqui

> API potente para gestão de instâncias e automações no WhatsApp. Conecte-se, envie mensagens e gerencie eventos facilmente.

{document.querySelectorAll("#footer a").forEach((a) => a.remove())}

<Note>
  **Base URL:** `https://api.wppfy.com`
</Note>

## <Icon icon="robot" size={22} /> Documentação para IA

Vai integrar usando um assistente de código? Escolha sua ferramenta, copie o prompt e cole no chat. Ele aponta a IA para o índice da documentação em [`llms.txt`](https://docs.wppfy.com/llms.txt) (versão completa em [`llms-full.txt`](https://docs.wppfy.com/llms-full.txt)).

<CodeGroup>
  ```text Claude Code icon="https://www.google.com/s2/favicons?domain=claude.ai&sz=64" wrap theme={null}
  Vou integrar a API de WhatsApp da WppFy neste projeto.
  Antes de escrever código, leia a documentação em https://docs.wppfy.com/llms.txt e abra as páginas .md dos endpoints que forem necessários.

  Regras:
  - Base URL: https://api.wppfy.com
  - Autenticação: header `token` com o token da instância, lido de variável de ambiente (WPPFY_TOKEN), nunca fixo no código.
  - Siga exatamente os payloads e respostas da documentação; não invente campos nem endpoints.
  - Trate erros HTTP (401, 404, 429, 500) e o estado da instância (disconnected, connecting, connected).

  Tarefa: [descreva aqui o que você quer construir]
  ```

  ```text Codex icon="https://www.google.com/s2/favicons?domain=openai.com&sz=64" wrap theme={null}
  Contexto: integração com a API de WhatsApp da WppFy.
  Documentação (índice para LLMs): https://docs.wppfy.com/llms.txt
  Documentação completa: https://docs.wppfy.com/llms-full.txt

  Leia a documentação antes de implementar. Use a Base URL https://api.wppfy.com e envie o header `token` com o token da instância vindo da variável de ambiente WPPFY_TOKEN. Use apenas endpoints e campos documentados, trate erros HTTP e escreva testes para as chamadas principais.

  Tarefa: [descreva aqui o que você quer construir]
  ```

  ```text Cursor icon="https://www.google.com/s2/favicons?domain=cursor.com&sz=64" wrap theme={null}
  @https://docs.wppfy.com/llms.txt

  Use a documentação da WppFy acima como referência para integrar a API de WhatsApp neste projeto.
  - Base URL: https://api.wppfy.com
  - Header de autenticação: `token` (token da instância, via variável de ambiente WPPFY_TOKEN)
  - Consulte as páginas .md listadas no llms.txt para os payloads exatos de cada endpoint.
  - Não invente campos; trate erros e o estado de conexão da instância.

  Tarefa: [descreva aqui o que você quer construir]
  ```

  ```text Replit icon="https://www.google.com/s2/favicons?domain=replit.com&sz=64" wrap theme={null}
  Crie uma integração com a API de WhatsApp da WppFy.
  Documentação: https://docs.wppfy.com/llms.txt (leia antes de começar).

  - Base URL: https://api.wppfy.com
  - Guarde o token da instância nos Secrets do Replit como WPPFY_TOKEN e envie no header `token`.
  - Para receber mensagens, exponha uma rota de webhook (POST) e registre os eventos recebidos.
  - Use somente endpoints e campos que estão na documentação.

  Tarefa: [descreva aqui o que você quer construir]
  ```

  ```text Lovable icon="https://www.google.com/s2/favicons?domain=lovable.dev&sz=64" wrap theme={null}
  Quero adicionar envio e recebimento de mensagens de WhatsApp ao meu app usando a API da WppFy.
  Leia a documentação em https://docs.wppfy.com/llms.txt antes de implementar.

  - Base URL: https://api.wppfy.com
  - O token da instância é secreto: guarde como secret (WPPFY_TOKEN) e faça as chamadas pelo backend (Edge Function), nunca direto do navegador.
  - Envie o token no header `token`.
  - Siga os payloads exatamente como na documentação.

  Tarefa: [descreva aqui o que você quer construir]
  ```

  ```text Bolt.new icon="https://www.google.com/s2/favicons?domain=bolt.new&sz=64" wrap theme={null}
  Integre a API de WhatsApp da WppFy neste app.
  Documentação para referência: https://docs.wppfy.com/llms.txt

  - Base URL: https://api.wppfy.com
  - Header `token` com o token da instância, lido de variável de ambiente (WPPFY_TOKEN) em um endpoint de servidor; não exponha o token no front-end.
  - Use apenas endpoints e campos documentados e trate os erros retornados pela API.

  Tarefa: [descreva aqui o que você quer construir]
  ```

  ```text v0 icon="https://www.google.com/s2/favicons?domain=v0.app&sz=64" wrap theme={null}
  Construa a integração com a API de WhatsApp da WppFy.
  Documentação: https://docs.wppfy.com/llms.txt

  - Base URL: https://api.wppfy.com
  - Faça as chamadas pelo servidor, com o token da instância em variável de ambiente (WPPFY_TOKEN) enviado no header `token`.
  - Nunca exponha o token no client.
  - Siga os payloads da documentação sem inventar campos.

  Tarefa: [descreva aqui o que você quer construir]
  ```
</CodeGroup>

## <Icon icon="triangle-exclamation" size={22} /> Recomendação Importante

<Warning>
  **Use WhatsApp Business**

  Recomenda-se fortemente utilizar contas de **WhatsApp Business** para evitar desconexões, limitações de envio e instabilidade na conexão.
</Warning>

## Autenticação

Para interagir com a API, você precisará configurar os *Headers* de suas solicitações. Escolha o tipo de acesso necessário:

<CodeGroup>
  ```bash Token da Instância theme={null}
  # Header para rotas de envio e controle de sessão
  token: SEU_TOKEN_AQUI
  ```
</CodeGroup>

## Estados da Sessão

Entenda o que significa cada estado de conexão para monitorar suas instâncias em tempo real.

<CardGroup cols={3}>
  <Card title="Desconectado" icon="circle-xmark" color="#ef4444">
    A instância está totalmente desconectada do servidor do WhatsApp.
  </Card>

  <Card title="Conectando" icon="rotate" color="#eab308">
    O sistema está tentando estabelecer o handshake com o WhatsApp.
  </Card>

  <Card title="Conectado" icon="circle-check" color="#22c55e">
    Conexão estável. A instância está pronta para enviar e receber dados.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.