API, Configurações

Disponível para o perfil: Administrador.

A página de API do Mediar Conversas é o ambiente destinado à integração técnica entre a plataforma e sistemas externos (como CRMs, sites, ERPs ou automações de marketing). Através desta tela, o administrador gera chaves de acesso, consulta a documentação técnica e testa as rotas de comunicação em tempo real.

Uma API por canal: cada integração criada em + Nova API é vinculada a uma única Sessão (canal de WhatsApp). Se você precisa disparar por mais de um canal, crie uma API separada para cada um, não é possível usar a mesma chave/token para múltiplos canais.

Principais funções

• Gestão de Tokens: criação e revogação de chaves de autenticação.
• Documentação Interativa: acesso direto à lista de endpoints e parâmetros.
• Sandbox: ambiente de teste para validar requisições sem sair do painel.
• Webhooks: configuração de disparos automáticos de eventos do sistema para URLs externas.

Caso de uso

Uma empresa utiliza um CRM externo para gerenciar suas vendas. Através da API, o desenvolvedor integra os sistemas para que, toda vez que um negócio for movido para "Fechado" no CRM, o Mediar Conversas envie automaticamente uma mensagem de boas-vindas ao contato utilizando uma Sessão WhatsApp específica.

Como acessar a página

No menu lateral, clique no menu Configuração e na aba API.

Explicação dos campos e ícones

• Botão Postman: atalho para baixar a coleção de requisições pré-configuradas para uso no software Postman.
• Botão + Nova API: abre o formulário para gerar uma nova integração vinculada a um canal.
• URL de Integração: o endereço base que deve ser utilizado nas chamadas externas.
• Bearer Token: a chave secreta de autenticação.

Ícones de ação:

• Atualizar (seta circular): gera um novo token para a API selecionada (o anterior é invalidado imediatamente).
• Editar (lápis): permite alterar o nome da integração.
• Excluir (lixeira): remove a integração e invalida o acesso externo permanentemente.
• Olho / Copiar: permite visualizar o token oculto e copiá-lo para a área de transferência.

Criando uma API

1. Clique no botão + Nova API no canto superior direito.
2. No modal que aparecerá, dê um Nome identificador para a integração (ex: CRM Vendas).
3. Selecione a Sessão (canal de WhatsApp) que será utilizada para os disparos desta API.
4. Clique em Salvar.
5. Importante: copie o token gerado imediatamente. Por questões de segurança, recomenda-se o armazenamento em local seguro, pois ele é a chave de acesso ao seu sistema.

Usando a API e documentação

Para facilitar o desenvolvimento, o Mediar Conversas disponibiliza uma documentação completa e testável dentro da própria interface:

1. Consulte a seção Documentação de rotas para visualizar todos os endpoints disponíveis.
2. Utilize o Sandbox selecionando uma API ativa no menu suspenso. Isso permite que você preencha os parâmetros e teste a requisição diretamente na página para ver a resposta do servidor.
3. A autenticação de todas as chamadas deve ser feita via header: Authorization: Bearer {seu_token}.

Webhooks e eventos

Os Webhooks permitem que o Mediar Conversas "fale" com o seu sistema externo em tempo real quando algo acontece:

• Configuração: informe a URL de callback no campo de destino.
• Eventos disponíveis: o sistema pode notificar sobre novas mensagens recebidas, tickets abertos, alterações de status e confirmações de entrega.
• Otimização: filtre apenas os eventos que são estritamente necessários para sua integração, reduzindo o tráfego de dados desnecessário.