O que é uma integração?

Integração é a capacidade de associar ou conectar o serviço do AgentBot a um serviço do cliente. Isso é feito utilizando informações dinâmicas provenientes do sistema que se deseja associar, necessitando da 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 que as organizações compartilhem e troquem 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, independentemente do tipo de tecnologia de envio e recebimento de dados utilizado (REST ou 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 a integração

Para realizar a integração de forma adequada, siga os passos abaixo:

1. Envio de requisitos: O cliente envia os requisitos ao departamento técnico.
2. Análise e execução: 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 forem necessárias metodologias de autenticação ou de configuração de VPNs, 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, sem a necessidade de consulta prévia do usuário.
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 serviço a ser consultado das APIs de terceiros está ligado ao endpoint que será consultado. Esses dados devem ser apresentados de forma clara e precisa, permitindo 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, é necessário ter:

1. Pergunta desencadeadora: A pergunta que iniciará a integração.
2. Rotas/endpoint/serviço: Utilizados para fornecer uma resposta.
3. Definição dos possíveis cenários: Documentar cada um dos possíveis cenários pelos quais o usuário passará, incluindo:
   • Dados utilizados pela Aivo para cada cenário e para realizar testes.
   • Exemplo de cada endpoint como comando curl.
   • 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. É necessário considerar:

• Tipos de dados enviados e recebidos: Formatos de envio e recebimento, como JSON, Arrays, XML.
• Conexão com serviços: É necessário saber se a rede possui algum nível de segurança. Se sim, será necessário:
  • Habilitar IPs
  • Criar VPNs
• Ambiente de testes: Verificar se há um ambiente de testes disponível.
• Autenticação de serviços: Caso utilize autenticação, é necessário especificar:
  • Tipo de autenticação utilizada.
  • Envio de credenciais dos ambientes disponíveis.

Fatores a considerar

Os serviços de terceiros podem exigir configurações específicas para aceitar o acesso do AgentBot. Portanto, é necessário 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, contendo cada um dos endpoints por serviço, os dados 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. Exemplos incluem:

1. Método de envio e complemento do endpoint:
   • Swagger permite indicar essas informações.
2. Notas do que será recebido pelo serviço.
3. Resposta recebida do serviço.
4. Formato de envio do JSON.
5. Tipo de parâmetro enviado caso se deseje carregar sem passar pela estrutura.
6. Mensagens recebidas: Curl, endpoint, response body, etc.
7. Testes diretos pelo Swagger: Inserção de dados ou envio de JSON.

Finalmente, um diagrama de fluxos pode ser apresentado como exemplo, mostrando 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. Essa metodologia oferece ao cliente e ao desenvolvedor uma visão geral do procedimento a seguir e das validações que serão realizadas.