Skip to main content
O canal API permite criar uma integração personalizada usando a API do Evo CRM para conectar sistemas externos e aplicações customizadas. Este canal oferece flexibilidade para integrações personalizadas através de endpoints REST.

​
Iniciando um Novo Canal

Para começar a criar um canal de API, use a ação destacada na tela de Canais. Botão New Channel O botão New Channel (destacado) é usado para iniciar a criação de um novo canal de comunicação.

​
Selecionando API

Na tela Select a channel type, clique no card API. Selecionando API como tipo de canal O card destacado representa a integração de API personalizada.

​
Configurando o Canal API

Após selecionar API, a tela Configure Channel é exibida. Tela de configuração do Canal API Dentro da área destacada, a tela mostra:

​
Identificação do Canal

  • API
  • Descrição: “Custom API integration”

​
Informações do Canal

  • Display Name *
    • Nome amigável para identificação
    • Exemplo: “API Support”
  • Channel Name *
    • Nome do canal (gerado automaticamente)
    • Exemplo: “api-support”

​
Configuração de Webhook

​
Informações sobre Canal API

A tela exibe uma caixa informativa com:
  • API Channel: Integração personalizada via API REST
  • Webhook URL: Opcional - URL para receber eventos em tempo real
  • Documentação: Consulte a documentação da API para implementação

​
Botões de Ação

  • Cancel
    • Descarta a configuração
  • Create Channel
    • Salva e ativa o Canal API
Após preencher os campos necessários, clique em Create Channel para finalizar a configuração.

​
Considerações Finais

  • O canal API requer conhecimento técnico para configuração
  • O Webhook URL é opcional, mas recomendado para receber eventos em tempo real
  • As credenciais de API devem ser mantidas seguras
  • Consulte a documentação da API para detalhes de implementação
  • Uma vez configurado, o canal permite integração com sistemas externos através de endpoints REST