Servicio externo: Publicar datos XML / JSON a un servicio web

En ion, puedes publicar datos en un servicio web en XML, JSON o cualquier formato que definas utilizando el tipo de integración "POST XML/JSON". Utilizarías este tipo de integración para extender los datos a un servicio SOAP o cualquier plataforma que requiera que los datos se envíen en un formato específico. Este documento proporciona instrucciones paso a paso para configurar una integración POST XML/JSON en ion.

Antes de que comencemos

Hay algunos elementos que deberás preparar antes de configurar la integración. Estos elementos se pueden encontrar en el HTML de tu formulario web externo o se pueden encontrar en la documentación de soporte de tu proveedor.

  • “Post-To" o URL de punto final
  • Solicitud de muestra que indica el formato de datos
  • Requisitos de autenticación, si corresponde
  • Valores aceptables para campos que no son de texto

Hay algunos pasos a seguir en la plataforma de ion antes de configurar la integración, estos son:

  • Crear campos de recopilación de datos
  • Crear forma(s) de ion
  • Configurar publicación de prueba

¡Empecemos!

1. Crea un mapeo de campo

Si sigues los pasos a continuación, se asignarán los campos de recolección de datos de ion a la estructura de datos requerida. Para comenzar, agrega tu nueva asignación de campo:

  1. Haz clic en la pestaña Integrations en el navegador lateral de tu ion console
  2. Haz clic en el botón verde "New field mapping” para un nuevo mapeo de campo
  3. Etiqueta el mapeo del campo y, opcionalmente, agrega una descripción
  4. En el menú Integration type, selecciona "Post XML/JSON"
  5. Pega la estructura de datos en el editor Post XML
      • La estructura de datos no tiene que ser XML
      • Está bien si hay valores de muestra en tu estructura de datos. Regresaremos y actualizaremos estos valores con marcadores de posición dinámicos un poco más tarde.

6. Guarda

2. Agrega campos salientes al mapeo de campos

Los campos de salida definen los datos que extiendes desde ion a tu formulario web externo.

  1. Haz clic en el botón verde "New outbound field” para agregar un nuevo campo a tu mapeo de campo
  2. Al agregar un nuevo campo, deberás seleccionar el menú desplegable Core Field en el menú desplegable de Data Collection
  • Para agregar un campo de formulario, usa los menús desplegables de Data Collection para seleccionar la categoría del campo de datos y luego el campo de recopilación de datos
  • O, para agregar un campo principal de ion, selecciona en el menú desplegable Core Field
  • O, para exportar varios campos de ion a tu campo externo, usa el campo Mashup conectando {{DataName}} {{DataName2}} , etc. en el editor
  • O, para reformatear un valor antes de exportarlo, usa el campo JavaScript para agregar lógica alrededor del valor recolectado en ion. Para acceder a los campos de recopilación de datos a través de Javascript, usa respondent.dataname.

3. Opcionalmente, haz que tu campo ejecuta obligatoriamente la integración.

4. Opcionalmente, agrega un valor predeterminado

5. Ingresa el término de sustitución

  • Este es el valor que conectaremos a tu estructura de datos como un marcador de posición dinámico.
  • Recomendamos usar algo simple que identifique el campo

6. Guarda

7. Repite estos pasos para cada campo que deba incluirse en la asignación Field Mapping, para el mapeo de campo.

 

3. Agrega términos de sustitución a POST XML o estructura de datos

Naveguemos de regreso a la estructura de datos POST XML y reemplacemos tus datos de muestra con los términos de sustitución definidos en el mapeo de campo.

  1. Haz clic en el botón "Edit field mapping” para editar la asignación de campo, junto a la etiqueta de asignación de campo para así abrir el POST XML
  2. Reemplaza todos los valores de datos de muestra con 
  3. Por ejemplo:
      • Change <FirstName>Jane</FirstName>
      • Para <FirstName></FirstName>

4. Guarda 

4. Opcionalmente, agrega campos entrantes

Aprovecha los campos entrantes para guardar datos de una respuesta XML en la recopilación de datos de ion. Abordaremos cómo analizar y guardar respuestas JSON en un paso posterior.

  1. Haz clic en el botón verde "New inbound field" para un nuevo campo de entrada
  2. Selecciona el campo de recopilación de datos de ion en el que deseas guardar el valor
  3. Ingresa una consulta de ruta para analizar el valor del XML
  4. Guarda
  5. Repite para cada campo que desees guardar en la recopilación de datos de ion

5. Crea la integración

  1. Navega de regreso a la pantalla de Integraciones
  2. Haz clic en la pestaña Integraciones
  3. Haz clic en el botón verde "New Integration" para una nueva integración
  4. Ingresa la etiqueta
  5. Opcionalmente, agrega una descripción
  6. Selecciona el mapeo de campo que acabas de crear
  7. Pega la URL del formulario en el editor
      • Esta es el "post to" o URL de punto final de tu formulario web.

8. Establece el máximo de reintentos

      • Si hay una interrupción del servicio con la plataforma externa, ion reintentará la publicación en la parte superior de la hora tantas veces como indiques aquí.

 

9. Opcionalmente, marca los requisitos especiales

      • Marca "Send form as multipart/form-data” para enviar formulario como multiparte y datos de formulario, si corresponde
      • Marca "Disable URL Encoding of all form data” para deshabilitar la codificación URL de todos los datos del formulario, en caso de que los datos no deban estar codificados en URL o si estás aprovechando los campos de salida de Javscript para codificar los datos de forma personalizada
      • Marca “Empty Fields" para excluir campos externos que no tienen valores de los datos POST.

10. Selecciona POST o PUT como método

11. Opcionalmente, agrega la dirección de correo electrónico de depuración

      • Las direcciones de correo electrónico especificadas aquí recibirán un correo electrónico cada vez que se ejecute la integración que muestre los datos publicados y la respuesta recibida. Esta es una característica que normalmente solo se usa para probar y solucionar problemas.

12. Opcionalmente, guarda la respuesta

      • Ingresa un nombre de datos aquí si deseas guardar la respuesta completa del servidor externo. Por lo general, esto se usa para guardar una respuesta que no es XML, de modo que se pueda usar un script de servidor para analizar los puntos de datos que se buscan guardar en la recopilación de datos de ion.

13. Agregar requisitos de autenticación

      • Si la integración requiere NTLM o autenticación básica, haz tu selección en el menú desplegable Remote authentication y selecciona las credenciales de cuenta correspondientes

14. Agrega encabezados personalizados

      • Si la integración requiere encabezados http personalizados, ingresa el nombre(s) y valor(s) aquí.

15. Guarda 

 

6. Agrega la integración a páginas de ion

La plataforma de ion ejecuta la integración según las reglas que tú crees. Se pueden agregar reglas a cualquier elemento procesable en tu publicación de ion. Las reglas de integración se ejecutan normalmente a nivel de formulario, al enviarlo o en un paso de evaluación. Sigue los pasos a continuación para agregar la integración a tus páginas de ion.

  1. Navega hacia la publicación
  2. Haz clic en el formulario, botón o enlace que buscas para activar el disparador para ejecutar la integración
  3. En Creative Studio, haz clic en +rules
  4. Selecciona la condición que debe cumplirse para ejecutar la integración
      • Normalmente se usa "No conditions required" para especificar que no se requieren condiciones

5. Selecciona "Run integration" para ejecutar la integración

6. Guarda

 

7. Prueba la integración

Para probar tu integración, utiliza la publicación de prueba que configuraste antes de comenzar los pasos de integración. Ten en cuenta que las integraciones no se ejecutan en el "Preview Mode", por lo que querrás abrir una URL para realizar pruebas. La integración se ejecutará una vez que envíes el formulario de ion o completes la acción que ejecuta la regla de integración.

Si está en la lista de distribución de correo electrónico de depuración, recibirás un correo electrónico que muestra los datos publicados y la respuesta del servidor externo. También querrás verificar que los datos que enviaste fueron recibidos por la plataforma externa.

 

¡Buen trabajo!

Una vez que hayas completado estos pasos, tu integración estará lista para usarse. Puedes agregar la regla para ejecutar la integración en todas las publicaciones aplicables.