Nombre de la Categoría: > API'S

API REST- Activación de Conversaciones

El API REST de Conversaciones es una interfaz utilizada para iniciar flujos de comunicaciones.

Algunos flujos de comunicaciones:

  • A un contacto
  • A un lote de hasta 10 contactos
  • A una lista de contactos completa que haya sido pre-cargada

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/

 

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. Esta API funciona sobre Conversaciones que previamente se hayan creado y estén activas. Esto significa que debe tener el ID de Conversación (conversaciónID).

4. Es importante tener ubicados los códigos de los campos requeridos para iniciar la conversación.

Ejemplo:

La conversación con ID (145164) requiere:

  • NOMBRE
  • APELLIDO
  • EMAIL
  • DEUDA
  • FECHAVENCIMIENTO

Para aprender como ubicar el código de un campo, acceder al siguiente enlace: http://help.danaconnect.com/es/editar-campo/

 

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:

 

Resumen de los métodos

1. startWithDataIdBody:

Inicia una conversación a un contacto.

Este es el método mas utilizado para activar flujos transacciones, ya que el mismo envia a través del POST los parámetros de un contacto requeridos para que funcione la conversación.

 

Ejemplos: Si la Conversación con ID 145164 requiere los parámetros:

  • NOMBRE
  • APELLIDO
  • EMAIL
  • DEUDA
  • FECHAVENCIMIENTO

 

Entonces el Request es:

Respuesta:

idResult se refiere al identificador del registro cargado en la lista de contactos.

startList:

Inicia una conversación a toda la lista pre-cargada y asociada a la conversación.

Por lo general este método trabaja de la mano con la carga masiva de contactos, por lo que es muy frecuente hacer una carga masiva de contactos y luego activar la conversación a toda la lista.

 

 

startWithDataListIdBody: Inicia una conversación a un lote de hasta 10 contactos de manera simultanea.

Este método funciona de manera similar a startWithDataIdBody, pero permite activar flujos hasta 10 contactos, lo cual reduce la cantidad de peticiones.

Ejemplo: Si la Conversación con ID 145164 requiere los parámetros:

  • NOMBRE
  • APELLIDO
  • EMAIL
  • DEUDA
  • FECHAVENCIMIENTO

Entonces el Request es:

Note que toda la petión está contenida entre corchetes [].

Respuesta:

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 – ERROR_INVALIDIDCONTACT: El id del contacto es inválido. Este código de error no aplica en el API REST.
  • idError 6 – INVALIDIDCONVERSATION: El ID de la conversación es inválido o no se corresponde con su cuenta.
  • idError 7 – ERROR_INSUFFICIENTBALANCE: La cuenta no posee créditos suficiente para enviar los mensajes.
  • 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)
  • idError 10 – ERROR_INVALIDTABLEORCOLUMN: El código del campo X no existe en la lista de contactos Y.
  • idError 11 – ERROR_CONTACTLISTEMPTY: La lista de contactos sobre la cual ha utilizado el método: startList está vacía.

 

Ejemplos de respuestas con error:


Ver Tambien:
« | »