top of page

API REST

Para desenvolvedores que queiram interagir com Bots criados na Plataforma MetaBot

Imagem decorativa de um desenvolvedor usando uma API
Imagem de um desenvolvedor de software trabalhando

Desenvolvedores podem utilizar a API REST da Plataforma MetaBot, acessando endpoints que permitem interagir de forma segura com Bots já criados (via UI), para testes e envio de mensagens por exemplo.

Imagem decorativa de um braço robótico

A API do MetaBot é uma interface poderosa projetada para ampliar e personalizar as funcionalidades dos bots criados na plataforma. Com ela, desenvolvedores podem integrar de forma eficiente os bots com sistemas legados, externos, automatizar processos e enriquecer as interações dos usuários com funcionalidades avançadas. Através de nossa API, é possível acessar um conjunto diversificado de métodos que permitem desde o envio e recebimento de mensagens até a gestão completa de sessões e análise de dados coletados pelos bots.

Entre os principais métodos disponíveis, destacam-se:

 

  • Autenticação e Autorização: Segurança robusta para garantir que apenas usuários e sistemas autorizados possam interagir com os bots.

  • Envio de Mensagens: Permite que os bots enviem mensagens personalizadas para os usuários, baseadas em eventos específicos ou agendamentos.

  • Recebimento de Respostas: Coleta as respostas dos usuários, possibilitando uma interação dinâmica e em tempo real.

  • Gestão de Usuários: Administra informações de usuários, como cadastro e histórico de interações.

  • Análise de Dados: Acesso a relatórios e métricas sobre o desempenho e eficácia dos bots.

 

Para garantir uma integração eficaz, a documentação da API do MetaBot é completa e atualizada regularmente, incluindo exemplos práticos de uso em ambientes de desenvolvimento comuns, como o Postman. A documentação é facilmente acessível e oferece uma visão detalhada de cada endpoint, incluindo parâmetros, respostas esperadas e tratamento de erros. Além disso, para facilitar o desenvolvimento e teste, a API é acompanhada de uma interface Swagger, que permite aos desenvolvedores explorar funcionalidades e testar chamadas de API diretamente de um navegador, sem a necessidade de escrever código inicialmente.

​

Para configuração e gestão de endpoints e chaves de credenciais para uso da API, veja Configurações. 

bottom of page