-
Qualtrics Platform -
Customer Journey Optimizer -
XM Discover -
Qualtrics Social Connect
Introducción a la API de Qualtrics
Acerca de la API de Qualtrics
La API de Qualtrics se puede utilizar para automatizar procesos repetitivos en Qualtrics o para importar información a Qualtrics o exportarla. Por ejemplo, un administrador de organización puede usar la API de Qualtrics para automatizar el proceso de creación de cuentas en lugar de crear cientos de cuentas individualmente. De forma similar, un usuario puede automatizar la creación de listas de contactos en lugar de compilar e importar listas de contactos manualmente. Qualtrics también cuenta con varias guías de soluciones de API que pueden ayudarle a determinar la mejor manera de utilizar la API para sus necesidades.
Acceso a la API para distintos productos
Qualtrics dispone de una variedad de productos que le permiten recopilar datos procesables en tiempo real. Algunos de estos productos incluyen la Plataforma de encuestas, Site Intercept y XM Directory (Target Audience). Una vez que haya adquirido la función API de Qualtrics, podrá usar la API para cualquier producto que forme parte de su licencia.
A continuación, se muestran los enlaces a la documentación de la versión más reciente de la API para cada uno de nuestros productos:
- Para obtener las API más recientes para la mayoría de los productos, consulte API de Qualtrics
- Site Intercept
Tenga en cuenta que siempre recomendamos que nuestros clientes utilicen la versión más reciente de la API.
Comprensión de la API de Qualtrics v3
La API de Qualtrics v3 es una API REST que le permite comunicarse con nuestro sistema o consultarlo mediante una sintaxis simple de URL. La comunicación con el sistema de Qualtrics se puede entender como una secuencia de solicitudes. Puede solicitar que la información se envíe a Qualtrics, se actualice, se borre o se devuelva a su sistema. Estas solicitudes se pueden realizar mediante solicitudes GET, POST, PUT o DELETE, que devuelven respuestas en formato JSON.
Con estos métodos, la API de Qualtrics le permite interactuar con partes del sistema de Qualtrics e integrar estas áreas con su CRM (plataforma de gestión de la relación con el cliente).
Preliminares
Parámetros de aprobación
Los parámetros constituyen los componentes de sus solicitudes. Todas las solicitudes de API requieren que se transfieran varios parámetros globales a Qualtrics, así como parámetros adicionales específicos de la solicitud y algunos opcionales.
Siempre tendrá que pasar el token de la API por la cabecera de la solicitud como X-API-TOKEN. En función de la solicitud específica que se esté ejecutando, es posible que deba pasar otros parámetros por la cabecera, por la URL o por el cuerpo de la solicitud. Al pasar parámetros por el cuerpo, deberá enviarlos como JSON. Cuando utilice este método, deberá especificar un tipo de contenido, es decir: application/json o multipart/form-data.
Ejemplo: En el siguiente ejemplo POST, en cURL especificamos la URL base, el tipo de contenido y el token en la cabecera. El ID de encuesta y el formato de exportación se especifican en
body.curl -X POST -H 'X-API-TOKEN: yourapitokenhere' -H 'Content-Type: application/json' -d '{
SurveyId': "SV_012345678912345",
"format": "csv"
}" 'https://yourdatacenterid.qualtrics.com/API/v3/responseexports'
Generación de un token de API
Se requerirá un token de API para acceder a la API de Qualtrics. Cada usuario de una licencia debe generar su propio token de API. El token de API de su cuenta es necesario para autenticar cada solicitud de API que cree. Se utiliza su token en lugar de la contraseña de su cuenta, lo cual ayuda a mejorar la seguridad de su trabajo. Para autenticarse, incluya su token en la cabecera HTTPS X-API-TOKEN.
Para generar un token de API
- Haga clic en el icono de opciones de usuario situado en la esquina superior derecha de su cuenta.
- Seleccione Configuración.
- Haga clic en ID de Qualtrics en la barra de navegación.
Atención: Se ha rediseñado la configuración de la cuenta. Para ver los ID de Qualtrics, haga clic en Cambiar a la versión anterior.
- En la casilla API, haga clic en Generar token.
Crear un secreto de cliente
- Haga clic en el icono de configuración de usuario en la esquina superior derecha de su cuenta de Qualtrics.
- Seleccione Configuración.
- Navegue a ID de Qualtrics.
Atención: Se ha rediseñado la configuración de la cuenta. Para ver los ID de Qualtrics, haga clic en Cambiar a la versión anterior. - Seleccione Gestor de clientes OAuth.
- Haga clic en Crear cliente.
- Introduzca un nombre de cliente.
- Si lo desea, introduzca una dirección de correo electrónico de contacto.
- Para Tipo de concesión, seleccione Credenciales de cliente.
- Haga clic en Crear cliente.
- Escriba el ID de cliente y el secreto de cliente y almacénelos en una ubicación segura.
Atención: Una vez que sale de esta ventana, el secreto de cliente es irrecuperable. Si pierde u olvida su Secreto de cliente, deberá repetir el proceso anterior para generar uno nuevo.