API para integrações
Como conectar o OSBChat a outros sistemas usando uma chave de acesso e a documentação interativa.
A tela API reúne a documentação interativa que o time técnico usa para conectar o OSBChat a outros sistemas, como CRMs e ferramentas de automação (por exemplo, n8n). Com ela é possível, entre outras coisas, criar campanhas e enviar mensagens de forma automática.
Só administradores acessam, e o uso da API exige o plano Professional.
Como começar
- Vá em Configurações → Chaves de API e clique em Criar chave. Dê um rótulo (por exemplo, "n8n produção") e, se quiser, uma data de validade.
- Copie a chave na hora. Ela aparece uma única vez e não pode ser vista de novo.
- Entregue a chave ao time técnico ou cole-a na ferramenta de automação.
- Na tela API, o time técnico consulta cada operação disponível e pode testá-la ali mesmo.
Cuidados com a chave
- Trate a chave como uma senha: não envie por e-mail nem compartilhe em conversas abertas.
- Crie uma chave para cada sistema, assim você revoga só a que for necessária.
- Revogar uma chave é definitivo: quem a usa deixa de funcionar e ela não pode ser reativada. Crie uma nova para substituir.
Onde saber mais
- API pública — organização, campanhas e mensagens: guia detalhado para quem vai integrar.
- Campanhas no painel: o que acontece do lado do painel quando uma campanha é criada pela API.