¿Qué es una integración?
Es la posibilidad de asociar o conectar el servicio de AgentBot con un servicio del cliente. Para que esta integración sea posible, se utiliza información dinámica proveniente de este otro sistema que se pretende asociar. Para ello, es preciso contar con la documentación necesaria de cómo acceder al contenido.
Integraciones a través de Web Service
Las integraciones se hacen a través de la tecnología de Web Service, la cual permite a las organizaciones compartir información con otros sistemas e intercambiar datos sin necesidad de conocer los detalles de sus respectivos sistemas de información.
Se pueden realizar integraciones a cualquier tipo de Web Service, independientemente del tipo de tecnología de envío y recepción de datos que se utilice (Rest o Soap).
El cliente debe brindar la información de cómo quiere hacer esta integración: documentación, accesos, metodologías, formas, etc. necesarias para integrarse a esos servicios, ya sean propios o brindados por un tercero.
Requerimientos
Para poder efectuar la integración de manera correcta se deberán respetar los siguientes pasos:
1. Se envían los requerimientos al cliente.
2. El cliente envía estos requisitos al departamento técnico.
3. Recepción de la documentación y requisitos por parte del departamento técnico de AgentBot, análisis y ejecución.
Tiempos
El tiempo de desarrollo de un Web Service, tiene una demora que oscila en una semana o menos, dependiendo de la complejidad de los datos y de cada caso.
Por ejemplo, si precisa de metodologías de autenticación, configuración de VPNs, la integración puede llevar más tiempo.
Usabilidad
Existen dos maneras de utilizar el Web Service en el agente:
1. Proactiva: en cuanto el usuario ingresa al bot, se le ofrece un listado u opciones disponibles. No es necesario que el usuario haga la consulta pertinente para que entre en acción.
2. Por demanda: el usuario solicita el servicio al consultar algo que lo active.
Requerimientos para crear una Integración Técnica
Integraciones de APIs de terceros
AgentBot permite cualquier tipo de integración con APIs de terceros, según las necesidades del cliente. Para que se puedan desarrollar desde Aivo, será necesario obtener la siguiente información:
Datos de servicios de terceros: cada uno de los servicios a consultar de las APIs de terceros van de la mano de endpoint que se consultará, los mismos deben ser presentados de forma clara y precisa para poder realizar ejemplos donde se pruebe cada integración al servicio. Se pueden presentar en alguno de los siguientes formatos:
- Apiary (sugerido).
- Swagger.
- Postman Collection.
- RAML
Por cada integración, se necesitará:
1. La pregunta que desencadenará la integración
2. Las rutas/endpoint/servicio que se utilizará para dar una respuesta
3. Definir los escenarios posibles (es importante documentar cada uno de los escenarios posibles por donde pasará el usuario):
- Datos a utilizar desde Aivo para cada escenario y para poder realizar las pruebas.
- Ejemplo de cada endpoint como comando curl.
- La respuesta que debe recibirse de cada servicio en todos los casos.
Se recomienda utilizar diagramas de flujos que indiquen el paso a paso y los servicios que se consultan durante el proceso.
Información adicional
La información que se solicita es para evitar retrasos en el desarrollo de la integración, ya que es necesario tener en cuenta:
- Tipos de datos a enviar.
- Tipos de datos a recibir.
- Formatos de Envío: JSON, Arrays, XML.
- Formatos Recibido: JSON, Arrays, XML.
Para poder realizar sin inconvenientes la conexión a los servicios, se necesita conocer:
- Si se dispone de algún nivel de seguridad de red, será necesario:
+ Habilitar IPs
+Crear VPNs
- Si se dispone de ambiente de test para poder realizar las pruebas.
- Si los servicios contarán con autentificación, indicar:
+ Tipo de autentificación que utilizarán.
+ Enviar credenciales de los ambientes disponibles.
Factores a tomar en cuenta
En ocasiones los servicios de terceros necesitan configuraciones específicas para aceptar el acceso por parte del Agentbot, es necesario que cada prestador del servicio los mantenga activos y con los accesos disponibles al momento de realizar las pruebas.
Ejemplos de documentación a recibir
- Endpoint por Servicios a través de Swagger:
La documentación debe estar sectorizada por cada flujo a realizarse, en él se deben encontrar cada uno de los endpoints por servicio, los datos a enviar, los datos a recibir, el concepto de qué hace el servicio, los tipos de datos enviados y recibidos y para que serán usado cada uno, como por ejemplo:
1. Swagger permite indicar el método de envío y el complemento del endpoint.
2. Las notas de lo que va a recibir el servicio
3. La respuesta que se debe recibir del servicio
4. El JSON a enviar o formato de envío
5. El tipo de parámetros a enviar si se desea cargar y no pasar por estructura
6. Los distintos mensajes que se recibirán, Curl, endpoint, response body, etc.
7. El swagger permite realizar pruebas directamente ya sea ingresando los datos o a través del JSON enviado.
Por último, se muestra un diagrama de flujos como ejemplo, donde se observa el proceso desde el inicio al final, con cada uno de los posibles casos, toma de decisiones y servicios a consultar. Ésta metodología permite tanto el cliente como al desarrollador tener una amplia visión del procedimiento a seguir y las validaciones a realizar.
Cancelar citas:
