> ## Documentation Index
> Fetch the complete documentation index at: https://docs.evolutionfoundation.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuração de API

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.

<img src="https://mintcdn.com/evoai-683d737d/kMlWJMPGu3qiQ2A1/user-guides/channels/images/01-before-creating-channel.png?fit=max&auto=format&n=kMlWJMPGu3qiQ2A1&q=85&s=8b04a77881b2efb849f30fae16704cf8" alt="Botão New Channel" width="1740" height="451" data-path="user-guides/channels/images/01-before-creating-channel.png" />

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**.

<img src="https://mintcdn.com/evoai-683d737d/kMlWJMPGu3qiQ2A1/user-guides/channels/images/01-selecting-api-channel.png?fit=max&auto=format&n=kMlWJMPGu3qiQ2A1&q=85&s=7adcdcbd3c8fc8e7bfb089db57c42952" alt="Selecionando API como tipo de canal" width="1234" height="910" data-path="user-guides/channels/images/01-selecting-api-channel.png" />

O card destacado representa a **integração de API personalizada**.

***

## Configurando o Canal API

Após selecionar API, a tela **Configure Channel** é exibida.

<img src="https://mintcdn.com/evoai-683d737d/kMlWJMPGu3qiQ2A1/user-guides/channels/images/02-configuring-api-channel.png?fit=max&auto=format&n=kMlWJMPGu3qiQ2A1&q=85&s=3988a08763621f7f9251d533f1a702c1" alt="Tela de configuração do Canal API" width="1036" height="792" data-path="user-guides/channels/images/02-configuring-api-channel.png" />

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

* **Webhook URL**
  * URL onde os eventos serão enviados
  * Exemplo: "[https://your-api.com/webhook](https://your-api.com/webhook)"
  * Campo opcional

### 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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.