Qualtrics Platform
Customer Journey Optimizer
XM Discover
Qualtrics Social Connect

Uso de la documentación de API de Qualtrics

Acerca de la documentación de API

Nuestra página Documentación de la API de Qualtrics detalla toda la documentación disponible actualmente.

Esta página le explica cómo navegar por nuestra documentación, describiendo qué trata cada sección y qué hay disponible.

Visión general

En el Resumen de la API, puede ver información sobre la API de Qualtrics en general, así como información sobre la Paginación (es decir, si ejecuta una solicitud de Lista de contactos y tiene más de 100 contactos, el resultado se paginará y se proporcionará una URL de página siguiente para obtener las 100 siguientes; esto se aplica a todas las solicitudes de recopilación).

Lista de elementos autorizados de servidores de Qualtrics

Consulte Servidores Qualtrics de lista de elementos autorizados.

URL base e IDs de centro de datos

Esta subsección le muestra cómo encontrar el ID del centro de datos que deberá incluir en la URL base para sus solicitudes de API.

Buscar sus ID de Qualtrics

Esta subsección le muestra dónde puede encontrar los diferentes ID que necesitará al ejecutar solicitudes API. Para los ID que no están disponibles en esta sección, consulte Ubicar IDs de Qualtrics inspeccionando el elemento.

Autenticación

La subsección Autenticación describe qué información se necesita para autenticar sus solicitudes, así como sugerencias para proteger su token de API. Para obtener más información sobre el proceso de autenticación, consulte Generación de un token de API.

Parámetros

La subsección Parámetros cubre los diferentes métodos para transferir parámetros en función del método HTTP que se utilice (GET, POST, PUT o DELETE).

Respuestas

La subsección Respuestas contiene ejemplos de los diferentes códigos de respuesta HTTP que se pueden devolver al ejecutar una solicitud, así como los posibles motivos para cada código de respuesta. Nuestra API siempre devuelve respuestas en JSON, excepto en el caso de la solicitud de exportación de respuesta, donde el archivo se puede devolver en cualquiera de nuestros formatos disponibles.

Consejo Q: Si no ve Respuestas o Actualización de versiones anteriores como opciones en la documentación, asegúrese de seleccionar Ver todo 7 en la parte inferior de la lista de la sección API.

Uso de las API de Qualtrics

Esta sección de la documentación tiene fragmentos de código en Python y Java para ayudarle a desarrollar flujos de trabajo para gestionar encuestas y usuarios y para obtener resultados de encuestas.

Advertencia: Las funciones de codificación personalizadas se proporcionan tal cual y pueden requerir conocimientos de programación para su implementación. Nuestro equipo de soporte técnico no ofrece asistencia ni consultoría sobre programación personalizada. En su lugar, puede preguntar a los usuarios especializados de nuestra comunidad. Si desea obtener más información sobre nuestros servicios de codificación personalizada, póngase en contacto con su Ejecutivo de cuentas de Qualtrics.

Referencia

La sección Referencia contiene información importante sobre los formatos de fecha y hora aceptables, los códigos de idioma, los límites de las solicitudes y los detalles sobre las suscripciones a eventos. Las suscripciones a eventos le permiten enviar notificaciones a una URL de publicación una vez que se produce un evento (por ejemplo, cuando se registra una respuesta).

Solicitudes

Para ayudar a organizar la documentación y ayudar a los usuarios a encontrar las solicitudes de API que están buscando, las solicitudes se clasifican de la siguiente manera:

Organizaciones
Divisiones
Grupos
Usuarios
Encuestas
Exportar respuestas de encuesta
Respuestas
Importaciones de respuestas
Biblioteca de mensajes
Biblioteca de imágenes
Distribuciones
Contactos de plataforma de análisis
Suscripciones de eventos
XM Directory (público objetivo)

Parámetros de solicitud y opciones

Cada solicitud de API tiene un nombre, una breve descripción, una tabla que enumera los posibles parámetros, la respuesta, una solicitud de ejemplo en cURL y el asistente “Pruébelo”. Comprender cómo utilizar esta información puede ayudarle a optimizar su trabajo.

Nombre, descripción y URL

Las primeras 3 cosas que se enumeran para cualquier solicitud de API son el verbo HTTP, el nombre de la solicitud de API y una breve descripción de la solicitud.

La URL utilizada en la solicitud (o “definición”) se enumerará junto al verbo HTTP.

Observe la estructura de desglose utilizada en las URL. Por ejemplo:

La solicitud Listas de distribución de listas utiliza la siguiente URL: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists
A continuación, puede utilizar un ID devuelto con esa solicitud para obtener una lista de distribución específica añadiendo el ID al final de la URL: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId
Para enumerar los contactos dentro de esa lista de distribución, añada contactos al final: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts
Para obtener un contacto específico, puede utilizar un contactId devuelto en la solicitud anterior: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts/:contactId

Lista de parámetros del cuerpo

Para cada solicitud de API, verá una tabla que enumera todos los parámetros de cuerpo posibles que se pueden utilizar (algunos serán opcionales, otros serán obligatorios). Esta tabla contiene la siguiente información:

Nombre de cada parámetro
Los formatos aceptados para cada parámetro
Si el parámetro es obligatorio
Una breve descripción del parámetro

Atención: Todos los nombres y valores de parámetro distinguen entre mayúsculas y minúsculas.

Solicitar muestra

El ejemplo de solicitud proporcionado en la documentación le muestra cómo formatear la solicitud en cURL. Estas solicitudes incluyen la URL raíz y todos los parámetros necesarios de la tabla de parámetros.

Consejo Q: Tenga en cuenta que, dado que los ID son solo ejemplos y no ID reales, las solicitudes de los ejemplos no funcionarán realmente, pero puede sustituirlas simplemente por ID de su propia cuenta.

Ejemplo de respuesta

Esta sección proporciona un ejemplo de lo que puede esperar recibir una vez que la solicitud de API sea correcta. Por ejemplo, si está utilizando la solicitud de API Crear usuario, su respuesta será el ID de usuario del usuario recién creado.

Finalización de solicitudes de API en el sitio de API

Nuestra documentación de API le permite ejecutar rápida y fácilmente una solicitud de API. (Tenga en cuenta que la mayoría de las solicitudes de API requieren ID de Qualtrics.)

Atención: Tenga cuidado al probar las API. Si introduce la información mínima necesaria para ejecutar una llamada a la API, este modal completará su solicitud de API. Los campos obligatorios varían en función de la llamada a la API y se enumerarán en la página de la llamada.

Seleccione entre Clave API y OAuth 2.0.
Introduzca el token de API de su cuenta en el campo Token de API. (O la información OAuth 2.0 correspondiente, si selecciona OAuth 2.0.)
Introduzca cualquier parámetro adicional.
Haga clic en Usuarios para seleccionar un servidor en el que realizar un test. Para la prueba más precisa, desea que coincida con el centro de datos de su cuenta.
Pulse Enviar solicitud de API para probar la llamada API.

Consejo Q: para saber qué valores son aceptables para cada parámetro, consulte la tabla de parámetros de la solicitud. También puede consultar el ejemplo cURL en la documentación.

Una vez que haya introducido los valores necesarios para su solicitud, verá el resultado de la llamada en “Respuesta”.

Atención: Algunas peticiones no funcionan con esta función de test. Esto se indicará en la página para la solicitud.

Muchas de las páginas de este sitio han sido traducidas del inglés original utilizando la traducción automática. Aunque en Qualtrics hemos realizado nuestra diligencia debida para obtener las mejores traducciones automáticas posibles, la traducción automática nunca es perfecta. El texto original en inglés se considera la versión oficial, y cualquier discrepancia entre el inglés original y las traducciones automáticas no son legalmente vinculantes.