Ferramentas para dev

Tudo que ajuda a integrar mais rápido, num lugar só.

Referência interativa

wevi.chat/docs/api/referencia lista todos os endpoints com parâmetros, respostas e exemplos em várias linguagens. É gerada da especificação OpenAPI, então nunca fica atrás do que a API faz.

Especificação OpenAPI

A própria API serve a especificação, sem autenticação:

curl https://api.wevi.chat/functions/v1/openapi

Serve para gerar cliente na sua linguagem, importar no Insomnia, validar contrato em teste ou alimentar uma ferramenta de IA.

A especificação traz, em cada uma das 88 operações, a explicação do que ela faz, o texto de cada parâmetro, um exemplo de requisição e de resposta, e os códigos de erro possíveis. Traz também os 30 eventos de webhook, com o corpo de cada um: a referência mostra os eventos ao lado dos endpoints.

# exemplo: gerar um cliente Python
npx @openapitools/openapi-generator-cli generate \
  -i https://api.wevi.chat/functions/v1/openapi \
  -g python -o ./wevichat-client

Coleção Postman e arquivo .http

  • Coleção Postman: importe e preencha a variável api_key. Cada requisição já vem com um corpo de exemplo pronto para mandar.
  • Arquivo .http: para a extensão REST Client do VS Code ou o cliente HTTP do JetBrains. Também com corpo preenchido.
  • Especificação em JSON.

Chaves de teste

Em Conta → Desenvolvedores, marque Chave de teste ao criar. A chave sai com o prefixo wevi_test_ e:

  • responde exatamente como a chave normal, com o mesmo formato;
  • registra o envio e devolve um wamid começando com wamid.TEST;
  • dispara os webhooks de verdade, para você testar o seu recebedor;
  • não manda nada para o WhatsApp.

Toda resposta de uma chave de teste vem com o header Wevi-Test-Mode: true.

É o jeito de construir a integração inteira sem gastar mensagem, sem incomodar cliente e sem medo de rodar duas vezes.

SDK TypeScript

npm install @wevichat/sdk

Sem dependência, funciona em Node 18+, Deno, Bun e Workers. Traz paginação automática, erro tipado com código estável e verificação de assinatura de webhook.

n8n

O nó oficial da Wevichat está publicado. No n8n, vá em Settings → Community Nodes → Install e informe:

@wevichat/n8n-nodes-wevichat

Ele traz dois blocos. O Wevichat cobre a API inteira, com as 92 operações organizadas por recurso: contato, conversa, mensagem, agente, campanha, automação, webhook, configuração, organização e, para parceiros, clientes. O Wevichat Trigger começa o seu fluxo quando algo acontece: cliente mandou mensagem, contato mudou de etapa, campanha terminou e mais 27 eventos. O gatilho cria e apaga o webhook sozinho quando você ativa e desativa o fluxo, e confere a assinatura de cada evento que chega.

As operações do nó são geradas da mesma especificação OpenAPI, então endpoint novo na API aparece no n8n na versão seguinte.

Três fluxos prontos para importar estão na pasta fluxos/ do pacote: lead do CRM vira conversa, transbordo avisa no Slack e conversa encerrada alimenta a planilha.

Se preferir não instalar nada, o nó HTTP Request comum continua funcionando. A página de `/send-template` traz um exemplo pronto para colar no canvas.

Servidor MCP

Dá ao Claude, ao ChatGPT ou ao Cursor acesso aos seus dados da Wevichat, para perguntar "quantas conversas ficaram sem resposta hoje?" e receber a resposta de verdade.

WEVI_API_KEY=wevi_test_sua_chave npx -y @wevichat/mcp

No Claude Desktop, em claude_desktop_config.json:

{
  "mcpServers": {
    "wevichat": {
      "command": "npx",
      "args": ["-y", "@wevichat/mcp"],
      "env": { "WEVI_API_KEY": "wevi_test_sua_chave" }
    }
  }
}

São 93 ferramentas, uma por operação, geradas da mesma especificação. Com WEVI_SOMENTE_LEITURA=1, sobram só as 45 que não mudam nada: útil para explorar sem chance de o assistente mandar mensagem por conta própria.

Comece por uma chave de teste. O assistente age com a sua chave, e uma chave com permissão de envio permite que ele mande mensagem para cliente de verdade.

Log de requisições

Em Conta → Desenvolvedores, a lista das últimas chamadas da sua organização mostra endpoint, status, tempo de resposta e código do erro dos últimos 7 dias. Toda resposta traz um X-Request-Id que aparece nesse log: é por ele que a gente acha a sua chamada quando você abre um chamado.

Próximo

Changelog