Nombre de la Categoría: > API'S

API REST – Recuperación de datos de un contacto a partir de código de External Trigger

El API REST de Recuperación de datos de un contacto a partir de código de External Trigger permite obtener desde sistemas externos los datos de un registro que haya sido ingresado en una lista de contactos en formato JSON.

Es posible obtener uno, varios o el contenido de todos los campos de un registro.

 

Para obtener los datos del contacto, en necesario capturar el parámetro con nombre “dana” que se genera al enviar emails o SMS que tengan la opción de External Trigger activa.

 

Esta funcionalidad es muy útil cuando en necesario enviar datos a una página desde un email o SMS. En vez de enviar todos los parámetros por la URL, se envía solo el código “dana”, el cual es auto-generado, y con este se puede recuperar el resto de los datos.

Algunos ejemplos en los que se utiliza está API son:

  • Pre-llenado de datos en un landing page.
  • Captura de datos adicionales en cotizadores de pólizas de seguros.
  • Validación de datos ingresados por un usuario en un formlario.
  • Pre-llenado de un formulario DANAConnect.

 

URL Base:

Todos los URLs referentes a esta API tiene la siguiente base:

Protocolo URL
HTTPS
Web Service
https://appserv.danaconnect.com/api/1.0/rest/conversation/data/

 

Consideraciones previas a utilizar el API:

  1. La empresa que va utilizar el API debe contar con un usuario y contraseña válidos.
  2. Por motivos de seguridad, el usuario que va a utilizar el API deber contar con un permiso especial. El administrador de su cuenta DANAConnect debe asegurarse de que este permiso esté habilitado.
  3. Es necesario que esté marcada la opción de External Trigger en los nodos de email o SMS para que se genere el parámetro “dana”.

 

Al activar la opción de External Trigger, todos los enlaces tendrán un parámetros con un código único llamado “dana” por enlace, por contacto en una Conversación.

Ejemplo de enlace generado:

 

Autenticación al API

EL API utiliza el mismo sistema de credenciales de usuarios DANAConnect.

Se utiliza el método de autenticación HTTP BASIC AUTH, el cual está basado en un login y password.

Login: El login consiste en el nombre de usuario concatenado con un @ y seguido del código de la compañía.

Ejemplo:

Nombre de usuario: apiuser

Código de compañía: formaciondana

Login para el API: apiuser@formaciondana

 

El método HTTP Basic Auth es el más común para autenticarse desde clientes REST:

Captura de los datos de un registro

Para obtener los datos de un registro es necesario capturar desde la URL el parámetro “dana” y contar con los nombre de los campos que se buscarán.

Por ejemplo: Sea una lista con nombre “Ejemplo de External Trigger”.

Los campos de esta lista son: UID, Nombre, Email, Teléfono, Celular, Estatus y IDINTERNO.

Para observar los códigos de cada campo, se debe acceder al botón de administración de campos:

Captura de datos:

El URL de captura de datos es: URL BASE + parámetro “dana”. Ejemplo:

https://appserv.danaconnect.com/api/1.0/rest/conversation/data/1OQUtlgy3j6jwhjNpiiw_8

Resutado:

{

“record”:{“EJEMPLOEXTERNALTRIGGER_CELULAR”:“+19540000000”,

“EJEMPLOEXTERNALTRIGGER_IDINTERNO”:“123ABC”,

“EJEMPLOEXTERNALTRIGGER_NOMBRE”:“Pedro Perez”,

“EJEMPLOEXTERNALTRIGGER_TELEFONO”:“+19540000001”,

“EJEMPLOEXTERNALTRIGGER_EMAIL:“nombre@dominio.com”,

“EJEMPLOEXTERNALTRIGGER_ESTATUS”:“Activo”},

“requestID”:“048b3a92-a668-4ff8-b005-d1c931bc7939”

}

Es posible especificar exactamente los campos que se desean consultar separados por coma. Ejemplo: para consultar los campos IDINTERNO y Estatus, la URL es:

https://appserv.danaconnect.com/api/1.0/rest/conversation/data/1OQUtlgy3j6jwhjNpiiw_8?fields=EJEMPLOEXTERNALTRIGGER_IDINTERNO,EJEMPLOEXTERNALTRIGGER_ESTATUS

Resultado:

{

“record”:{“EJEMPLOEXTERNALTRIGGER_IDINTERNO”:“123”,

“EJEMPLOEXTERNALTRIGGER_ESTATUS”:“Activo”},

“requestID”:“84c75100-1a58-4df6-a220-61acfdb39ede”

}

Códigos de error:

  • idError 1 – ERROR_INVALIDUSER: Usuario inválido.
  • idError 2 – ERROR_INVALIDLOGINPWD: Usuario y password inválido
  • idError 3 – ERROR_ACCESSDENIED: El usuario no posee el permiso para ejecutar APIs de DANA.
  • idError 4 – ERROR_INVALIDCOMPANY: El código de la cuenta DANA es inválido.
  • idError 5 – Invalid Dana parameter: El parámetro “dana” es inválido.
  • idError 8 – ERROR_INTERNALERROR: Error interno DANAConnect.
  • idError 9 – ERROR_RUNTIMERROR: Error interno DANAConnect, principalmente causado por un error en el formato de la petición (JSON)

Ejemplo de error cuando el parámetro “dana” es incorrecto:

{

“wsError”:{“idError”:5,“errorDescription”:“Invalid Dana parameter”},

“requestID”:“97846275-8d46-4afe-b61e-b35bdef3926a”

}

 

 

 


Ver Tambien:
« | »