Plantilla de artículo

Acerca de los casos de uso de API

Esta página destaca las formas en que otros clientes de Qualtrics aprovechan 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

La automatización de la construcción de solicitudes de API generalmente la realiza un especialista en 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 de un código personalizado. Los pasos a continuación demuestran cómo realizar este proceso.

Siga los pasos a continuación una vez que haya elaborado su encuesta :

1. Navegar hasta el Encuesta pestaña y abre tu Flujo de la Encuesta.
   
2. Hacer clic Agregar a continuación o Añade un nuevo elemento aquí.
3. Seleccionar 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 desea utilizar (es decir, GET, PUT, POST o DELETE).
   Atención:Aunque PATCH está disponible en el elemento de servicio web, no se puede utilizar con la API de Qualtrics .
6. Hacer clic Agregar un encabezado personalizado para enviar al servicio web.
7. Ingresar X- API-TOKEN En el campo Encabezado del servicio web y tu ficha en el Valor campo.
   
8. Agregue todos los parámetros de encabezado necesarios para su solicitud de API haciendo clic en el signo más (+) firmar.
9. Si ha configurado el método en POST o PUT, haga clic en Agregar un parámetro de cuerpo para enviar al servicio web e ingrese todos los parámetros y valores requeridos.
10. Establezca el valor de cada parámetro a su derecha.
    Consejo Q:Querrás usar Texto canalizado para valores con datos dinámicos, como nombre, apellido y correo electrónico.

    

11. Si está utilizando API v2.x en el elemento Servicio web, deberá hacer clic en Agregar un parámetro de consulta para enviar al servicio web para agregar los parámetros y valores de URL para las solicitudes.

JSON

Puede pasar sus 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, application/ json o text/ json). Este método generalmente lo realiza un especialista en TI de su organización, ya que este proceso requiere la implementación de código personalizado.

Cadena de consulta

URL raíz:

encuesta api​

Para el primer parámetro que se agrega a la URL raíz, incluya un “?” seguido del nombre del parámetro, un signo igual y el valor del parámetro (por ejemplo, ?Version=2.4). Agregue todos los parámetros subsiguientes con un ampersand inicial “&” (por ejemplo, &Request=importPanel).

URL raíz + parámetros obligatorios:

encuesta api​?Versión=2.4&Solicitud=importPanel
&Usuario=kathleenb_gen&Token=12345678901234567890&Formato= XML

Continúe agregando 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 completa.

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

encuesta api ? qualtrics =2.4&Request=importPanel
&Usuario=kathleenb_gen&Token=12345678901234567890&Formato= XML
&LibraryID=UR_12345678901234567890&ColumnHeaders=1&Email=3& URL=https%3A%2F% qualtrics.com
%2FWRQualtricsControlPanel%2FFile.php%3FF%3DF_3IeSPPh9HjXwaj3%26download%3D1&Nombre=Prueba
& FirstName= 1& LastName= 2& AllED = 1

Puede encontrar más información sobre las cadenas de consulta en nuestra página de soporte Pasar información a través de cadenas de consulta.

Plataforma de la encuesta

Automatizar la importación de una lista de contactos

Puedes utilizar el Crear contactos Importar solicitud para importar lotes de contactos a su cuenta de Qualtrics . A través de esta solicitud puedes importar listas JSON de personas desde tu CRM a Qualtrics. Estos contactos se pueden importar cargando un archivo JSON y configurando el parámetro de encabezado Content-Type en multiparte/datos de formulario, o incluyendo los contactos en el cuerpo de la solicitud y configurando el tipo de contenido en aplicación/ json.

Automatizar la creación de un contacto

En lugar de actualizar manualmente las listas de contacto con nuevos miembros de contacto , puede automatizar el proceso mediante el uso de Crear Contacto pedido. Esta solicitud agrega un nuevo contacto a una lista de contactos existente. Para esta solicitud, necesitará el ID de la Lista de correo y cualquier otro campo que desee agregar al contacto. Estos deberán pasarse a través del cuerpo de la solicitud, configurando Content-Type en aplicación/ json.

Generando tus propios enlaces individuales

Es posible que necesite distribuir su encuesta a través de un correo interno en lugar del correo de Qualtrics . Con la API de Qualtrics , puedes construir Enlaces individuales que rastrean la información personal del encuestado sin tener que utilizar el correo de Qualtrics .

Para realizar esta tarea, necesitarás utilizar dos solicitudes API : Crear Distribución y enlaces de Distribución. Antes de comenzar, deberá importar una lista de contactos a Qualtrics, ya sea manualmente o mediante la solicitud API . Crear contactos Importar.

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

• ID de Lista de correo (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 CrearDistribución)

Automatizar la descarga de datos para prepararlos para importarlos a su CRM

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

• Crear respuesta de exportación: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 respuesta.
• Progreso de la exportación de Get Response:Esta solicitud se utiliza para verificar el progreso de la exportación utilizando el ID de exportación de respuesta proporcionado en la primera solicitud. Una vez que percentComplete llega a 100, puedes usar la última solicitud para obtener el archivo.
• Archivo de exportación de Get Response:Una vez que el archivo esté listo, puedes utilizar esta solicitud para descargarlo. Se exportará como un archivo comprimido. Tenga en cuenta que, si bien 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 del centro de datos correcto en esta solicitud.

Esta secuencia de solicitudes descarga sus datos sin procesar, lo que le facilita la obtención de sus datos y luego importar esas respuestas a su CRM, almacén de datos, etc.

XM Directory

Actualización de un contacto (Lista contactos del Directorio y Actualizar Contacto del Directorio )

A veces es posible que desees actualizar un contacto a través de la API. Para ello, necesitará el ID de Contacto del contacto. El Lista de contactos del Directorio La solicitud de API le permite buscar el ID de Contacto de un contacto, que luego puede usar para solicitudes de API posteriores. Primero explicaremos la solicitud API. Lista de contactos del Directorio y luego Actualizar Directorio de Contacto.

Todo lo que necesitarás para el Lista de contactos del Directorio La solicitud es el ID del Directorio . El resultado para el Lista de contactos del Directorio La solicitud será recibir el ID de Contacto del contacto para que luego pueda usarlo para solicitudes como Actualizar Directorio de Contacto.

Hay entonces dos parámetros principales de interés para el Actualizar Directorio de Contacto solicitud: ID de Directorio y ID de Contacto . Como resultado de la Actualizar Directorio de Contacto solicitud, el contacto especificado se actualizará con cualquier información que haya cambiado en función de los parámetros de su solicitud.

Guías de soluciones API

Puede encontrar varias guías de soluciones para Gestión de encuestas, Administrar usuarios, Administrar grupos de usuarios, y Cómo obtener Respuestas de la Encuesta en nuestro Sitio web de documentación de la API v3.