Manual de Integración Bots

Manual de Integración BOTS V1 (MAN-PP-03-01 ) #

Contenido

 

  1. Control de Cambios. 2
  2. Introducción. 3
  3. Web Service Rest tipo GET. 4
  4. Web Service Rest tipo POST. 6

 

1.           Control de Cambios #

 

VersiónFechaDescripción de la ModificaciónResponsable (s)
128/10/2019Creación del ManualLuis Eduardo Rodríguez

 

 

2.           Introducción #

 

Aldeamo está en la capacidad de suministrar infraestructura, servicios, interfaz, protocolos y recursos necesarios para el envío de correos electrónicos mediante una integración a través de un Protocolo SMTP o HTTP

Para la integración de nuestros clientes a la plataforma de E-mail, contamos con un protocolo SMTP y HTTP que permite a nuestros aliados el envío y recepción de mensajes de correo electrónico. Esta tecnología facilita la integración rápida y transparente con el fin de potencializar el negocio de nuestros clientes y asociados.

Aldeamo cuenta con integraciones con proveedores de diferentes servicios de comunicación, principalmente operadores móviles (SMS, Flash SMS), proveedores de servicios de correo electrónico (Gmail, Hotmail, Yahoo etc.) y proveedores de servicios de mensajería OTP (WhatsApp, Facebook Messenger, Twitter, RCS, etc.). La comunicación en cada una de estas integraciones está protegida por los mecanismos de seguridad que ofrezca cada canal, principalmente basados en TLS 1.2 (HTTPS, SMTPS, VPN).

 

 

 

3.           Web Service Rest tipo GET #

 

Para la conexión de nuestros clientes a la plataforma de BOTS de Aldeamo contamos con un API que permite a nuestros aliados la integración con el sistema proveído por Aldeamo. Esta tecnología facilita una integración rápida y transparente con el fin de potencializar el negocio de nuestros clientes y asociados.

A continuación, se detalla esta tecnología para un mayor entendimiento de su uso y complejidad.

Este api está basado en llamados HTTP GET y POST hechos por el cliente a una URL.

  • Autenticación: El cliente se autentica por medio de una llave API_KEY que se obtiene desde la plataforma y se envía de la siguiente manera.

auth: “VARCHAR”

 

 

Bajo este esquema se debe enviar una petición con la siguiente estructura.

  • URL para consumir el servicio:

https://apibot.aldeamo.com/bots

 

  • Ejemplo de la petición por canal

GET https://apibot.aldeamo.com/bots/users

auth: VARCHAR

channel: (facebook, twitter, web, whatsapp)

 

return: JSON

{

“status”: true,

“codigo”: 0,

“message”: “Users for channel”,

“data”: [

{

“id”: “1”,

“user_id”: “50767212797”,

“name”: “Humberto Zamora”,

“email”: null,

“phone”: “50767212797”,

“date_created”: “2019-05-02 19:04:49”,

“last_active”: “2019-09-09 17:20:59”

},

{

“id”: “2”,

“user_id”: “573107856908”,

“name”: null,

“email”: null,

“phone”: “573107856908”,

“date_created”: “2019-05-02 19:29:18”,

“last_active”: “2019-08-16 19:36:48”

},

]

}

 

  • Ejemplo de la petición por cliente

 

GET https://apibot.aldeamo.com/bots/messages

 

auth: VARCHAR

channel: (facebook, twitter, web, whatsapp)

client_id: INT (user_id)

 

return: JSON

{

“status”: true,

“codigo”: 0,

“message”: “Client messages”,

“data”: [

{

“id”: “10”,

“user_id”: “50760816607”,

“message”: “Hola bot”,

“time”: “1556826151”

},

{

“id”: “27”,

“user_id”: “50760816607”,

“message”: “menu”,

“time”: “1556827446”

},

{

“id”: “28”,

“user_id”: “50760816607”,

“message”: “Nuevos servicios”,

“time”: “1556827508”

},

]

}

 

4.           Web Service Rest tipo POST #

 

Para la conexión de nuestros clientes a la plataforma de BOTS de Aldeamo contamos con un API que permite a nuestros aliados la integración con el sistema proveído por Aldeamo. Esta tecnología facilita una integración rápida y transparente con el fin de potencializar el negocio de nuestros clientes y asociados.

A continuación, se detalla esta tecnología para un mayor entendimiento de su uso y complejidad.

Este api está basado en llamados HTTP GET y POST hechos por el cliente a una URL.

  • Autenticación: El cliente se autentica por medio de una llave API_KEY que se obtiene desde la plataforma y se envía de la siguiente manera.

auth: “VARCHAR”

Bajo este esquema se debe enviar una petición con la siguiente estructura.

  • URL para consumir el servicio:

https://apibot.aldeamo.com/bots

 

  • Ejemplo de la petición para enviar mensajes

 

POST https://apibot.aldeamo.com/bots/messages

 

auth: VARCHAR

channel: (facebook (use client facebook id in Database), sms, web)

client_id: INT

msg: TEXT

 

return: JSON

{

“status”: true,

“codigo”: 0,

“message”: “Message sent”,

“data”: 32

}

 

 

Powered by BetterDocs

Leave A Comment

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.