Gerenciamento de API - Integração e Acesso a APIs


Gerenciamento de API - Integração e Acesso a APIs



📘 Recurso: Gerenciamento de API — Integração Avançada com o Chat-Bot

O módulo de Gerenciamento de API do Chat-Bot foi projetado para permitir que desenvolvedores, empresas e integrações externas se conectem diretamente ao ecossistema da plataforma usando interfaces seguras, estáveis e altamente otimizadas.
Com essa funcionalidade, é possível ampliar automações, criar integrações personalizadas e controlar recursos internos programaticamente — tudo com segurança empresarial.
⚙️🔗🚀


🌐 O que a Integração via API Permite Fazer?

A API do Chat-Bot fornece uma ponte direta entre seu sistema e a plataforma, permitindo que você:

🔐 1. Amplie a funcionalidade do seu aplicativo com segurança

Crie novos recursos, automatize processos internos ou conecte seu software ao Chat-Bot mantendo total segurança e controle.

💪 2. Utilize uma API robusta e confiável

A API do Chat-Bot foi projetada para lidar com operações de forma estável, escalável e consistente — mesmo em ambientes de alto volume.

🔄 3. Garanta troca de dados perfeita

As informações fluem automaticamente entre sua aplicação e o Chat-Bot, mantendo tudo sincronizado em tempo real.

🧩 4. Construa integrações personalizadas

Conecte o Chat-Bot a CRMs, ERPs, plataformas de vendas, automações internas ou qualquer solução utilizada em sua empresa.

🧠 5. Tenha acesso programático aos recursos principais

Permite controlar via código:

  • contatos

  • mensagens

  • modelos

  • status

  • grupos

  • bots

Ideal para automatizar fluxos, reduzir tarefas manuais e criar sistemas inteligentes.


📖 Visão Geral da Área de Gerenciamento de API

Nesta seção você pode:

  • Ativar ou desativar o acesso à API

  • Gerar e gerenciar tokens de API

  • Visualizar URLs e endpoints disponíveis

  • Configurar permissões específicas (Habilidades do Token)

Tudo centralizado em um painel de alto nível e fácil operação.
🧭👨‍💻


🔌 Habilitando o Acesso à API — Passo a Passo Completo

EtapaDescrição
1. Ativar o acesso à APIHabilite a chave que libera o uso da API na página de Configurações.
2. Gerar token de APIClique em Gerar novo token para criar um token único de autenticação.
3. Copiar o URL base da APIExemplo tradicional: https://chat-bot-saas.corbitaltechnologies.com/api/v1/
4. Observação: Subdomínio do FornecedorInclua o subdomínio do seu Fornecedor (ex.: vatsal) em cada chamada.
5. Salvar alteraçõesClique em Salvar alterações para ativar a integração.

🔧 Interface correspondente:

Gerenciamento de API


🔑 Autenticação da API

ParâmetroDetalhes
Token da APIChave única do Fornecedor, equivalente a uma senha de alto nível.
AutenticaçãoUse o token Bearer no cabeçalho das requisições.

📌 Exemplo de cabeçalho para requisições:

Authorization: Bearer YOUR_API_TOKEN_HERE Content-Type: application/json

🏗️ Estrutura dos Endpoints da API

Elementos essenciais:

ElementoDescrição
URL base da APIRaiz onde todas as requisições são direcionadas.
Subdomínio do FornecedorIdentificador único que define seu ambiente de trabalho.
Ponto final completoCombinação da URL base + subdomínio + recurso desejado.

📩 Exemplo de Endpoint — Recuperar Modelos do WhatsApp

API Base URL: https://chat-bot-saas.corbitaltechnologies.com/api/v1/ Fornecedor (Subdomain): vatsal Endpoint Completo: https://chat-bot-saas.corbitaltechnologies.com/api/v1/vatsal/templates

Este endpoint permite recuperar todos os modelos de mensagens disponíveis para uso no WhatsApp.


🛡️ Habilidades do Token (Permissões)

Essas permissões determinam exatamente quais ações cada token pode executar.
Configure-as com cautela para garantir segurança e controle total.

CategoriaPermissõesDescrição
ContatosCriar, Ler, Atualizar, ExcluirGerenciar informações de contato.
StatusCriar, Ler, Atualizar, ExcluirControlar e registrar status de contatos e campanhas.
FontesCriar, Ler, Atualizar, ExcluirGestionar origens de contatos e mensagens.
ModelosLerAcessar modelos de mensagens WhatsApp.
Bots de mensagensLerVisualizar configurações do bot de mensagens.
Bots de modeloLerVisualizar configurações de bots baseados em modelo.
GruposCriar, Ler, Atualizar, ExcluirGerenciar grupos de contatos para segmentação.
Envio de mensagensEnvio texto, multimídia e modelosPermite envio de todos os tipos de mensagens do WhatsApp.

📚 Navegação

◀️ Página anterior: Gerenciamento de Cache
▶️ Próxima página: Gerenciamento de Webhooks


** O tempo é base no fuso horário America/New_York