Quais são as integrações possíveis no bot com IA?

O que é uma integração?

É a possibilidade de associar ou conectar o serviço do AgentBot a um serviço do cliente. Para que essa integração seja possível, utiliza-se informação dinâmica proveniente do sistema que se deseja associar. Para isso, é preciso contar com a documentação necessária sobre como acessar o conteúdo.

Integrações por meio de Web Service

As integrações realizadas por meio da tecnologia Web Service permitem às organizações compartilhar e intercambiar dados com outros sistemas, sem a necessidade de conhecer detalhadamente cada sistema de informação.

É possível realizar integrações com qualquer tipo de Web Service, independente do tipo de tecnologia de envio e recebimento de dados utilizado (Rest o Soap).

O cliente deve fornecer informações sobre como deseja realizar tal integração: documentação, acessos, metodologias, formas, etc. necessárias para integrar-se a esses serviços, sejam eles próprios ou de terceiros.

Requisitos

Para realizar a integração de forma adequada é preciso realizar os passos abaixo:

1. Os requisitos são enviados ao cliente.

2. O cliente envia esses requisitos ao departamento técnico.

3. O departamento técnico do AgentBot recebe a documentação e os requisitos para análise e execução.

Tempos

O prazo de desenvolvimento de um Web Service varia em torno de uma semana, ou menos, dependendo da complexidade dos dados e de cada caso.

Se precisar de metodologias de autenticação ou de configuração de VPNs, por exemplo, a integração poderá levar mais tempo.

Usabilidade

Há duas formas de utilizar o Web Service no AgentBot:

1. Proativa: assim que o usuário acessa o bot é exibida uma lista ou as opções disponíveis. O usuário não precisa fazer uma consulta para que o bot entre em ação.

2. Sob demanda: o serviço é ativado mediante a consulta do usuário.

Requisitos para criar uma Integração Técnica

Integrações de APIs de terceiros

O AgentBot permite qualquer tipo de integração com APIs de terceiros, de acordo com as necessidades do cliente. Para que a Aivo possa realizar a integração, o cliente deve fornecer as seguintes informações:

Dados de serviços de terceiros: cada um dos serviços a ser consultado das APIs de terceiros está ligado ao endpoint que será consultado, esses dados devem ser apresentados de forma clara e precisa, que permita criar exemplos para testar cada integração com o serviço. São admitidos os seguintes formatos:

– Apiary (recomendado).

– Swagger.

– Postman Collection.

– RAML

Para cada integração será preciso ter:

1. A pergunta que desencadeará a integração

2. As rotas/endpoint/serviço utilizados para dar uma resposta

3. A definição dos possíveis cenários (é importante documentar cada um dos possíveis cenários pelos quais o usuário passará):

• Os dados que serão utilizados pela Aivo para cada cenário e para realizar os testes.

• Exemplo de cada endpoint como comando curl.

• A resposta que será recebida de cada serviço em todos os casos.

Recomenda-se utilizar Fluxogramas que indiquem o passo a passo e os serviços consultados durante o processo.

Informações adicionais

As informações solicitadas evitam atrasos no desenvolvimento da integração, uma vez que é necessário levar em conta:

– Os tipos de dados enviados.

– Os tipos de dados recebidos.

– Formatos de envio: JSON, Arrays, XML.

– Formatos de recebimento: JSON, Arrays, XML.

Para realizar a conexão com os serviços sem problemas é necessário saber:

– Se a rede possui algum nível de segurança. Em caso afirmativo, será necessário:

+ Habilitar IPs

+ Criar VPNs

– Se há um ambiente de testes disponível.

– Se os serviços utilizam autenticação. Em caso afirmativo, é preciso especificar:

+ O tipo de autenticação utilizada.

+ Enviar credenciais dos ambientes disponíveis.

Fatores que deve-se levar em conta

Às vezes os serviços de terceiros requerem configurações específicas para aceitar o acesso do Agentbot. Portanto, é preciso que cada prestador mantenha o serviço ativo e com os acessos disponíveis na hora de realizar os testes.

Exemplos de documentação recebida

– Endpoint por Serviços mediante Swagger:

A documentação deve ser setorizada por cada fluxo realizado, nela deve constar cada um dos endpoints por serviço, os dados que serão enviados e recebidos, o conceito do que o serviço faz, os tipos de dados enviados e recebidos e a função de cada um deles, como, por exemplo:

1. O Swagger permite indicar o método de envio e o complemento do endpoint.

2. As notas do que será recebido pelo serviço.

3. A resposta que será recebida do serviço

4. O JSON que deverá enviar o formato de envio.

5. O tipo de parâmetro que será enviado caso se deseje carregar e não passar pela estrutura.

6. As diversas mensagens que serão recebidas: Curl, endpoint, response body, etc.

7. O swagger permite realizar testes diretamente, inserindo os dados, ou por meio do JSON enviado.

Finalmente, apresenta-se um diagrama de fluxos como exemplo, no qual se observa o processo do início ao fim, com cada um dos possíveis casos, tomada de decisões e serviços que serão consultados. Esta metodologia oferece tanto ao cliente quanto ao desenvolvedor uma visão geral do procedimento a seguir e das validações que serão realizadas.

Cancelar consulta