API

API

Integração com Sistemas Externos

A API será utilizada para facilitar os processos de integração da sua plataforma. Para acessar essa seção, clique no ícone API do seu menu lateral.

Você verá a seguinte tela:

Adicionar API

Clique em Adcionar no canto superior da tela.

Assim que selecionar esse botão, um pop up se abrirá para que você preencha as informações. Veja o exemplo:

Conheça os campos de preenchimento:

Campo	Descrição
Nome da API	Defina a forma como irá identificar essa API. Esse nome estará visível apenas para os Administradores.
Enviar por	Escolha qual canal/conexão será responsável por esse envio.
Token de autenticação	Sera enviado como autorização no header. Se existir prefixo, deverá ser informado aqui. Ex: Bearer, Token.

Clique em Salvar para finalizar e pronto!

Gerencie as APIs

Na parte inferior do painel de API, você pode visualizar informações como: Nome da API, URL da API, URL do Token, URL do WebHook (Status WhatsApp), URL do WebHook (Status Mensagem) e Token de Autenticação.

No canto superior direito, você encontra algumas ações. Conheça cada uma delas a seguir:

Descrição	Aparência
Copie o Token
Edite as informações presente no pop up de criação da API
Gere um novo Token
Delete as configurações cadastradas

Postman

Clique em Postman para realizar o download da Collection com todas as rotas disponíveis.