Primeiros Passos

Esta página apresenta o caminho mais rápido para realizar sua primeira integração e entender os principais recursos disponíveis na plataforma.

Ao final deste guia você terá:

  • Gerado um token de acesso
  • Realizado sua primeira chamada na API
  • Entendido a estrutura da plataforma
  • Conhecido os próximos passos para evoluir sua integração

Visão Geral da Plataforma

A API está organizada em três grupos principais:

APIFinalidade
Chat APIConversas, mensagens, canais, chatbot e atendimentos
CRM APIContatos, contas, carteiras, campos personalizados e CRM
Core APIEquipes, usuários, departamentos e recursos compartilhados

Passo 1 — Gerar um Token de API

Antes de realizar qualquer chamada é necessário gerar um token permanente.

Acesse:

Ajustes → Integrações → Integração via API

Clique em:

Novo → Informe um nome → Salvar

Copie o token gerado.

⚠️

Importante

O token concede acesso à sua conta.

Nunca exponha essa chave em aplicações front-end, sites públicos ou repositórios.

Saiba mais:

👉 Autenticação


Passo 2 — Realizar sua Primeira Chamada

Após gerar o token, você já pode testar sua integração.

Exemplo:

curl -X GET \
"https://api.wts.chat/chat/v1/channel" \
-H "Authorization: Bearer pn_xxxxxxxxxxxxxxxxx"

Se o token estiver válido, a API retornará uma resposta de sucesso.


Passo 3 — Entenda o Fluxo Básico

A maioria das integrações segue o fluxo abaixo:

Autenticar
    ↓
Criar ou localizar contato
    ↓
Enviar mensagem
    ↓
Receber eventos via webhook

Esse fluxo atende a maior parte dos cenários de integração.


Passo 4 — Configurar Webhooks

Os webhooks permitem que seu sistema seja notificado automaticamente quando eventos ocorrerem.

Exemplos:

  • Nova mensagem recebida
  • Contato criado
  • Contato atualizado
  • Atendimento iniciado
  • Atendimento encerrado
  • Eventos do chatbot

Saiba mais:

👉 Webhooks


Passo 5 — Escolha sua Estratégia de Integração

A plataforma pode ser integrada de diferentes formas.

Desenvolvimento próprio

Utilize diretamente a API REST para criar integrações personalizadas.

Ideal para:

  • Sistemas internos
  • ERPs
  • CRMs
  • Aplicações próprias

N8N

Plataforma Low-Code para automações avançadas.

Ideal para:

  • IA
  • Automações
  • Fluxos internos
  • Integrações empresariais

👉 N8N


Make

Plataforma No-Code para integrações rápidas.

Ideal para:

  • Fluxos simples
  • Marketing
  • Automações operacionais

👉 Make


Recursos Mais Utilizados

Chat API

Permite:

  • Enviar mensagens
  • Consultar conversas
  • Transferir atendimentos
  • Encerrar atendimentos
  • Gerenciar chatbot

CRM API

Permite:

  • Criar contatos
  • Atualizar contatos
  • Gerenciar tags
  • Criar oportunidades
  • Consultar carteiras

Core API

Permite:

  • Consultar equipes
  • Consultar usuários
  • Consultar departamentos
  • Utilizar recursos compartilhados

Boas Práticas

Utilize sempre HTTPS

Todas as chamadas devem ser realizadas utilizando conexões seguras.


Armazene tokens com segurança

Nunca exponha tokens em:

  • JavaScript público
  • Aplicações mobile sem backend
  • Repositórios Git

Respeite os limites da API

A plataforma possui mecanismos de proteção para garantir estabilidade.

👉 Consulte a página de Rate Limiting


Trate erros adequadamente

Sempre implemente tratamento para respostas:

400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

👉 Consulte a página Tratamento de Erros