Qualtrics Platform
Customer Journey Optimizer
XM Discover
Qualtrics Social Connect

Plantilla de artículo

Acerca de la documentación de la API

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

Esta página le muestra cómo navegar por nuestra documentación, describiendo lo que se analiza en cada sección y lo que está disponible.

Visión general

En el Descripción general 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 nextPage para obtener los siguiente 100; esto se aplica a todas las solicitudes de recopilación).

Incluir en la lista de permitidos los servidores Qualtrics

Ver Lista de permitidos servidores Qualtrics.

URL base e ID de centro de datos

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

Cómo encontrar sus identificaciones de Qualtrics

Esta subsección le muestra dónde puede encontrar los distintos ID que necesitará al ejecutar solicitudes de API . Para las identificaciones que no están disponibles en esta sección, consulte Localización de identificadores de Qualtrics mediante la inspección del elemento.

Autenticación

El Subsección de 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 Generando un token API.

Parámetros

El Subsección de parámetros cubre los diferentes métodos para pasar parámetros dependiendo del método HTTP que se utilice (GET, POST, PUT o DELETE).

Respuestas

El Subsección de Respuestas Contiene ejemplos de los diferentes códigos de respuesta HTTP que se pueden devolver cuando se ejecuta una solicitud, así como las posibles razones 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 desde versiones anteriores como opciones en la documentación, asegúrese de seleccionar Ver todos los 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 administrar encuestas y usuarios y para obtener resultados de encuesta .

Advertencia: Las funciones de codificación personalizadas se proporcionan tal cual y pueden requerir conocimientos de programación para implementarlas. 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 personalizados, contacto con su Qualtrics. Ejecutivo de Cuenta.

Referencia

La sección de Referencia contiene información importante sobre formatos de fecha y hora aceptables, códigos de idioma, límites de solicitudes y detalles sobre suscripciones a evento . Las suscripciones a Evento le permiten enviar notificaciones a una URL de publicación una vez que ocurre 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 buscan, las solicitudes se clasifican de la siguiente manera:

Organizaciones
Divisiones
Grupos
Usuarios
Encuestas
Exportación de Respuestas de Encuesta
Respuestas
Importaciones de respuestas
Biblioteca de mensajes
Biblioteca de imágenes
Distribuciones
Contactos de la plataforma Información
Suscripciones de eventos
XM Directory (público Objetivo )

Parámetros y opciones de la solicitud

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 agilizar 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”) aparecerá siguiente al verbo HTTP.

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

La solicitud de listas de correo utiliza la siguiente URL: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists
Luego, puede utilizar una ID devuelta con esa solicitud para obtener una lista de distribución específica agregando la ID al final de la URL: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId
Para lista los contactos dentro de esa lista de distribución, agregue contactos hasta el 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 corporales

Para cada solicitud de API , verá una tabla que enumera todos los parámetros de cuerpo posibles que se pueden usar (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 los parámetros distinguen entre mayúsculas y minúsculas.

Solicitar muestra

El muestra de solicitud que se proporciona 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 requeridos de la tabla de parámetros.

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

Ejemplo de respuesta

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

Completar solicitudes de API en el sitio de API

Nuestro Documentación 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 Identificaciones de Qualtrics.)

Atención: Tenga cuidado al probar las API. Si ingresa la información mínima requerida para ejecutar una llamada API , Este modal completará su solicitud de API. Los campos obligatorios varían según la llamada API y aparecerán en la página de la llamada.

Seleccione entre Clave API y OAuth 2.0.
Ingrese el token de API de su cuenta en el Token de API campo. (O la información OAuth 2.0 correspondiente, si eligió OAuth 2.0).
Introduzca cualquier parámetro adicional.
Hacer clic Usuarios para elegir un servidor para realizar la prueba. Para obtener la prueba más precisa, desea que esto coincida con el centro de datos de su cuenta.
Prensa 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 de cURL en la documentación.

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

Atención:Algunas solicitudes no funcionan con esta función de prueba. Esto se indicará en la página de 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.