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:

image?url=https%3A%2F%2F3541975055-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM5B652UsmGn3Q7h9Du1t%252Fuploads%252Fv1YIj6inQyISJOFIGDV8%252Fimage.png%3Falt%3Dmedia%26token%3D1e230d19-11c4-4743-a503-82a7699ec8a9&width=768&dpr=4&quality=100&sign=7ae8f2e&sv=2
Adicionar API
Clique em Adicionar 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:

image?url=https%3A%2F%2F3541975055-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM5B652UsmGn3Q7h9Du1t%252Fuploads%252FWcDlDBd3NDqGpI7VGsEr%252Fimage.png%3Falt%3Dmedia%26token%3Dd03e3344-0469-4bd4-99cf-55e149586a2b&width=768&dpr=4&quality=100&sign=2550a20b&sv=2

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.

image?url=https%3A%2F%2F3541975055-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM5B652UsmGn3Q7h9Du1t%252Fuploads%252FdwIVi0sHjury8v0cw6Dk%252Fimage.png%3Falt%3Dmedia%26token%3Df62a8804-36f0-4ec5-904a-fef019feb102&width=768&dpr=4&quality=100&sign=7bfc511&sv=2

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.

Você achou esse artigo útil?

  • Administrador

    Administrador Painéis do Admin Você encontrará as seguintes opções no pa...
  • Canais

    Canais Canais de Comunicação Agora que você escolheu as configurações ba...
  • WhatsApp Oficial (WABA)

    WhatsApp Oficial (WABA) Api Oficial Agora você pode realizar uma conexão diretamente co...
  • WhatsApp Baileys (QRCode)

    WhatsApp Baileys (QRCode) WhatsApp Baileys Agora você pode realizar uma conexão diretam...
  • Wavoip

    Wavoip Ligações por Whatsapp Agora você pode realizar e receber ligações...