Casos de uso de API comunes

Acerca de los casos de uso de API

En esta página se destacan las formas en que otros clientes de Qualtrics están aprovechando la API de Qualtrics. A continuación encontrará una lista de solicitudes de API comunes que utilizan nuestros clientes y los casos de uso asociados con cada solicitud.

Métodos comunes

Servicio web

Automatizar la construcción de solicitudes API suele realizarlo un especialista de TI de su organización, ya que este proceso requiere la implementación de código personalizado. Sin embargo, en algunos casos, puede utilizar una encuesta de Qualtrics para automatizar en lugar del código personalizado. Los pasos siguientes muestran cómo realizar este proceso.

Siga los pasos siguientes una vez que haya creado su encuesta:

1. Vaya a la pestaña Encuesta y abra el Flujo de la encuesta.
   
2. Haga clic en Añadir abajo o Añadir nuevo elemento aquí.
3. Seleccione Servicio web.
4. Inserte la URL para la solicitud de API desde la sección Definición de la documentación.
   
5. Seleccione el método que desea utilizar (es decir, GET, PUT, POST o DELETE).
   Atención: Aunque PATCH está disponible en el elemento Servicio web, no se puede utilizar con la API de Qualtrics.
6. Haga clic en Agregar un encabezado personalizado para enviar al servicio web.
7. Introduzca X-API-TOKEN en el campo Cabecera para servicio Web y su token en el campo Valor.
   
8. Añada todos los parámetros de cabecera necesarios para su solicitud de API haciendo clic en el signo más (+).
9. Si ha establecido el método en POST o PUT, haga clic en Agregar un parámetro de cuerpo para enviar al servicio web e introduzca todos los parámetros y valores necesarios.
10. Establezca el valor de cada parámetro a la derecha.
    Consejo Q: querrá utilizar Texto dinámico para valores con datos dinámicos, como Nombre, Apellidos y Correo electrónico.

    

11. Si utiliza API v2.x en el elemento Servicio Web, debe hacer clic en Añadir un parámetro de consulta para enviar al servicio Web para añadir los parámetros y valores URL para las solicitudes.

JSON

Puede pasar los parámetros como JSON a través del cuerpo de la solicitud. Tenga en cuenta que al utilizar este método, debe especificar un tipo de contenido (es decir, aplicación/json o texto/json). Este método lo suele realizar un especialista de TI de su organización, ya que este proceso requiere la implementación de un código personalizado.

Cadena de consulta

URL raíz:

https://Survey.qualtrics.com/WRAPI/ControlPanel/api.phpPara

el primer parámetro que se añade a la URL raíz, incluya un “?” seguido del nombre del parámetro, un signo igual y el valor del parámetro (por ejemplo, ?Versión=2.4). Agregue todos los parámetros subsiguientes con un signo & principal “&” (p. ej., &Request=importPanel).

URL raíz + parámetros necesarios:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?Version=2.4&Request=importPanel
 &User=kathleenb_gen&Token=12345678901234567890&Format=XML

Continúe añadiendo o añadiendo cualquier otro parámetro adicional a su URL siguiendo el mismo proceso descrito anteriormente. Una vez que haya incluido todos los parámetros deseados, tendrá una solicitud completada.

URL raíz + Parámetros necesarios + Parámetros adicionales:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?Version=2.4&Request=importPanel
 &User=kathleenb_gen&Token=12345678901234567890&Format=XML
&LibraryID=UR_12345678901234567890&ColumnHeamp=1&F_stamp;Email=3
&Fquamp Rqu;URL=htt%Phal%2ph3A;ColumnHeamp=1&F_FtricName=3&Fquamp;URL=htt%2ph3A%2ph3A%2ph3A

Puede encontrar más información sobre las cadenas de consulta en nuestra página de soporte Transferencia de información mediante cadenas de consulta.

Plataforma de encuestas

Automatización de la importación de una lista de contactos

Puede utilizar la solicitud Crear importación de contactos para importar lotes de contactos a su cuenta de Qualtrics. Mediante esta solicitud, puede importar listas JSON de personas de su CRM a Qualtrics. Estos contactos se pueden importar cargando un archivo JSON y configurando el parámetro de cabecera Tipo de contenido en datos de múltiples partes/formularios, o incluyendo los contactos en el cuerpo de la solicitud y configurando el Tipo de contenido en application/json.

Automatización de la creación de un contacto

En lugar de actualizar manualmente las listas de contactos con nuevos miembros de contacto, puede automatizar el proceso utilizando la solicitud Crear contacto. Esta solicitud agrega un nuevo contacto a una lista de contactos existente. Para esta solicitud necesitará el ID de lista de distribución y cualquier otro campo que desee añadir al contacto. Estos deberán pasar por el cuerpo de la solicitud, estableciendo el tipo de contenido en application/json.

Generar sus propios enlaces individuales

Es posible que tenga que distribuir su encuesta a través de un distribuidor de correo interno en lugar del distribuidor de correo de Qualtrics. Con la API de Qualtrics, puede crear enlaces individuales que realicen un seguimiento de la información personal de un encuestado sin tener que utilizar el distribuidor de correo de Qualtrics.

Para realizar esta tarea, deberá utilizar dos solicitudes de API: Crear enlaces de distribución y Distribución. Antes de empezar, tendrá que importar una lista de contactos a Qualtrics de forma manual o mediante la solicitud de API Crear importación de contactos.

Los parámetros de interés para la solicitud Crear enlaces de distribución y distribución son:

• ID de lista de distribución (cada distribución está vinculada a una lista de distribución)
• ID de encuesta
• Descripción (el nombre de la distribución)
• Acción (el valor aquí debe ser CreateDistribution)

Automatización de la descarga de datos en preparación para importar a su CRM

Si diariamente necesita datos de muchas encuestas, puede utilizar nuestra API para obtener respuestas. La API v3 utiliza una serie de tres solicitudes para obtener datos:

• Crear exportación de respuestas: Esta solicitud inicia el proceso de exportación y se utiliza para especificar el formato de archivo y otras preferencias. Esto devolverá un ID de exportación de respuestas.
• Obtener progreso de exportación de respuestas: Esta solicitud se utiliza para comprobar el progreso de la exportación utilizando el ID de exportación de respuesta proporcionado en la primera solicitud. Una vez que Porcentaje completo llega a 100, puede utilizar la última solicitud para obtener el archivo.
• Obtener archivo de exportación de respuestas: Una vez que el archivo esté listo, puede utilizar esta solicitud para descargarlo. Se exportará como un archivo comprimido. Tenga en cuenta que, aunque la mayoría de las solicitudes de API funcionarán cuando el ID del centro de datos no sea correcto en la URL, esta solicitud no lo hará. Asegúrese de utilizar el ID de centro de datos correcto en esta solicitud.

Esta secuencia de solicitudes descarga sus datos brutos, lo que facilita la obtención de sus datos y luego importa esas respuestas a su CRM, data warehouse, etc.

XM Directory

Actualizar un contacto (Enumerar contactos del directorio y Actualizar contacto del directorio)

A veces, es posible que desee actualizar un contacto a través de la API. Para ello, necesitará el ID de contacto del contacto. La solicitud de API Contactos del directorio de lista le permite buscar un ID de contacto del contacto, que puede utilizar para solicitudes de API posteriores. Primero explicaremos la solicitud de API Lista de contactos del directorio y, a continuación, Actualizar contacto del directorio.

Todo lo que necesitará para la solicitud de Lista de contactos del directorio es el ID de directorio. El resultado de la solicitud de Contactos del directorio de lista será recibir el ID de contacto del contacto para que pueda utilizarlo para solicitudes como Actualizar contacto del directorio.

Hay dos parámetros principales de interés para la solicitud de contacto del directorio de actualización: ID de directorio e ID de contacto. Como resultado de la solicitud Actualizar contacto de directorio, el contacto especificado se actualizará con la información que haya modificado en función de los parámetros de su solicitud.

Guías de la solución API

Puede encontrar varias guías de soluciones para gestionar encuestas, gestionar usuarios, gestionar grupos de usuarios y obtener respuestas de encuestas en nuestro sitio web de documentación de API v3.