Nombre de la Categoría: Envío de Comunicaciones > Nodo API Comm (Rest Webservice)

Cómo configurar un Nodo API Rest dentro de un flujo

Es posible incluir un nodo API en los flujos de comunicación, a través de una sencilla ventana de configuración que permite agregar el URI, los parámetros y el request, así como la autenticación. Esto posibilita disparar webservices dentro de los flujos como consecuencia de un evento, petición o acción del usuario final.

¿Para qué se usa este nodo?

Este nodo se utiliza para:

  • Iniciar peticiones HTTP a servicios web externos a DANAconnect de manera transaccional
  • Iniciar peticiones a APIs de DANAConnect de manera transaccional
  • Configurar las acciones a tomar con los parámetros respuesta que retornan dichos webservices

 

Para configurar un nodo de Comunicación API Rest usted debe:

Ingresar a Envío de Comunicaciones

Seleccionar la Conversación que desea utilizar o crear una nueva conversación

Al estar dentro del flujo de la comunicación, sólo después de crear un nodo de otro tipo, como Email, SMS o Llamada, es cuando el sistema le permitirá crear un nodo API. Debe hacer clic en el botón de Inicio, en el nodo seguido del cual quiere hacer el llamado al webservice y seleccionar API.

Acceder al Nodo de API, haciendo clic sobre el mismo.

 

En la ventana de configuración nombre el paso para mantener una referencia de su contenido (opcional pero recomendado). Seleccione el tipo de método de petición HTTP de la data: POST, GET, DELETE o PUT.

 

 

Ingrese el URL al cual se llamará en el campo URL:

 

 

Indique el tipo de contenido que será retornado por el servicio entre los tres tipos de el Content-type:

  • application/x-www-form-urlencoded
  • application/json
  • application/xml

El área de la ventana de configuración en donde se agrega el cuerpo de la petición cambiará de interfaz dependiendo del tipo de contenido que haya seleccionado en el paso anterior: se presentará como Raw para json o xml y preformateado para  x-www-form-urlencoded. Agregue los parámetros de entrada del request que irán en el cuerpo de la petición.

Utilice el botón insertar etiquetas para visualizar la lista de etiquetas que vienen de la lista de contactos/Base de datos asociadas a la conversación.

 

 

Si el API Rest requiere un encabezado, puede seleccionar la pestaña de Headers, en el botón de agregar encabezados y agregue los que necesite

 

Haga clic en la pestaña de configuración. Seleccione el tipo de configuración a utilizar: Authorization Basic o No Authorization (sin autorización requerida).

Agregue el nombre de usuario y password en caso de haber seleccionado la autorización básica.

 

Haga check en «save response code» si desea guardar la respuesta del API Rest en la base de datos y configure el parámetro «FIELD_CODE / $.wsResult.resultDescription» con el nombre completo con el código del campo de la base de datos (Ejemplo: CODIGO_BASE_DATOS_CODIGO_CAMPO) en donde desea almacenar el código de respuesta HTTP.

Debe usar JsonPath/xPath para poder obtener la respuesta del Rest en la plataforma DANAConnect.

Puede configurar dos respuestas:

  1.  Cuando el API Rest responde satisfactoriamente
  2. Cuando la respuesta es incorrecta

 

Haga clic en «Add field to Update» y agregue los parámetros correspondientes  los campos de la BD/lista contacto que desea que se actualicen con el response del webservice. Los nombres de los campos deben corresponderse con el código completo del campo de la base de datos que desea actualizar (Ejemplo: CODIGO_BASE_DATOS_CODIGO_CAMPO)

 

 


Sobre la funcionalidad de Inserción de etiquetas asistidas:

Permite reutilizar etiquetas previamente usadas en la conversación, así como también aquellas correspondientes a la lista de contactos establecida.

Esta funcionalidad ayuda a evitar errores humanos y simplifica el proceso de insertar etiquetas:

  • Asociadas a los parámetros de las peticiones
  • En la cabecera de las peticiones

Cargar una plantilla de request desde la librería

Es posible usar plantillas de peticiones que hayan sido previamente salvadas o que estén en la librería de Integraciones de DANAConnect.

Al configurar una petición de un API Rest se puede tener una cantidad considerable de parámetros, tanto en la cabecera, cuerpo y acciones que se deben tomar en función del JSON de respuesta y esta funcionalidad permite administrar una librería privada de plantillas de peticiones a APIs REST para ser organizadas y reutilizadas con facilidad.

Administrar plantillas permite guardar y recuperar una conversación tanto en otros nodos API como en otras conversaciones.

Adicionalmente DANAConnect ha dispuesto de una librería de plantillas pre-definidas con peticiones a otros sistemas, tales como: Zapier, etc. esto con el fin de facilitar la integración con otros CRM, Helpdesk o sistemas administrativos.


Enviar una petición de prueba

Permite activar una petición manualmente para probar su correcto funcionamiento antes de activar una conversación.

Esta funcionalidad es muy útil para la depuración, ya que permite especificar los parámetros dinámicos y recibir una respuesta en línea.

Adicionalmente a la respuesta, se obtiene información adicional, tal como:

  • SPEED_DOWNLOAD – Average download speed – Velocidad de descarga media
  • SPEED_UPLOAD – Average upload speed – Average upload speed
  • TOTAL_TIME – Total transaction time in seconds – Tiempo total de transacción en segundos
  • HEADER_SIZE – Total size of all headers received – Tamaño total de todos los encabezados recibidos
  • RESPONSE_CODE – The last response code – El último código de respuesta
  • REQUEST_SIZE – Total size of issued requests, currently only for HTTP requests – Tamaño total de las solicitudes emitidas, actualmente solo para solicitudes HTTP
  • PRIMARY_IP – IP address of the most recent connection – Dirección IP de la conexión más reciente

 


Descripción de los elementos de sintaxis JSONPath para hacer el request al archivo JSON

A continuación una tabla con la descripción de los elementos de sintaxis JSONPath para hacer el request al archivo JSON

JSONPath Descripción
$ El objeto / elemento raíz
@ El objeto / elemento actual
. or [] Operador child (hijo). Los índices siempre comienzan por 0.
.. Descenso recursivo.
* Comodín. Todos los objetos / elementos independientemente de sus nombres.
[] Operador de subíndice. En JSON, como en Javascript, es el operador de matriz nativo. Los índices siempre comienzan por 0.
[,] Permite nombres alternativos o índices de matriz como un conjunto. Los índices siempre comienzan por 0.
[start:end:step] Operador de corte de matriz.
?() Aplica una expresión de filtro (script).
() Expresión de script, utilizando el motor de script subyacente.

 

 

 


Ver Tambien:
« | »