Introducción básica a la integración de API

Qué hay en esta página:

Acerca de la integración de API

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 utilizar la API de Qualtrics para automatizar el proceso de creación de cuentas en lugar de crear cientos de cuentas de forma individual. Del mismo modo, un usuario puede automatizar la creación de listas de contactos en lugar de compilar e importar de forma manual las listas de contactos (EN). Qualtrics también cuenta con varias Guías de soluciones de API (EN) que pueden ayudarle a determinar la mejor manera de utilizar la API para sus necesidades.

ConsejoQ: ¿Le gustaría obtener más información sobre el tema? Eche un vistazo a nuestro seminario web bajo demanda.
Atención: Puede que las integraciones de API requieran 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 acerca de nuestros servicios de programación personalizada, póngase en contacto con su Account Executive de Qualtrics.

Acceso a la API para distintos productos

Qualtrics dispone de una variedad de productos que le permiten recopilar datos procesables en tiempo real. Entre estos productos se incluyen: Plataforma de encuestas, Site Intercept e iQ 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:

También puede encontrar la documentación de las versiones anteriores de la API de Plataforma de encuestas y la API de la antigua Target Audience a continuación:

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

El sistema de API actual de Qualtrics utiliza una URL raíz para realizar solicitudes:

https://yourdatacenterid.qualtrics.com/API/

La URL raíz es la base para cualquier solicitud de API. Tenga en cuenta que el protocolo es https y, por lo tanto, está encriptado para garantizar la protección de sus credenciales.

Puede encontrar el ID de su centro de datos iniciando sesión en su cuenta y mirando la URL en la barra de direcciones del navegador. La parte anterior a qualtrics.com es el ID de su centro de datos. Como alternativa, si no está utilizando el ID correcto del centro de datos, recibirá una notificación en la respuesta HTTP cuando ejecute una solicitud de API, en la que se indicará la ID del centro de datos que debería utilizar en su lugar. En el siguiente ejemplo, el centro de datos es au1.

TRANSFERENCIA DE PARÁMETROS

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 de solicitud POST, en cURL especificamos la URL base, el tipo de contenido y el token en la cabecera. El ID de la encuesta y el formato de exportación se especifican en el cuerpo.

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. Se requiere el token de API de su cuenta para autenticar todas las solicitudes 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 bajo la cabecera HTTP X-API-TOKEN.

ConsejoQ: Para generar un token, el usuario debe tener el permiso de Acceso a API habilitado para su cuenta. Si su organización no tiene acceso a la función API de Qualtrics, póngase en contacto con su Account Executive para obtener más información.

PARA GENERAR UN TOKEN DE API

  1. Haga clic en la silueta en la esquina superior derecha de su cuenta.
  2. Seleccione Configuración.

  3. Haga clic en ID de Qualtrics en la barra de navegación.
  4. En la casilla API, haga clic en Generar token.
Advertencia: No haga clic en Generar token si ya dispone de uno. Su token de API solo se tiene que generar una vez. Si genera un token nuevo y cuenta con integraciones que utilizan el token antiguo, estas se interrumpirán. La generación de un token nuevo es irreversible; no es posible recuperar tokens anteriores.

OAuth de API

Atención: Está leyendo acerca de una función a la que solo pueden acceder los Administradores de organización.

OAuth 2.0 es una estructura que propuso la IETF en el 2012. Al realizar llamadas a la API, se genera un token. En ocasiones, le gustaría trabajar con usuarios de terceros, pero no les quiere proporcionar sus datos de inicio sesión ni el token, ya que pueden usarlo más tarde para acceder a la API. Tampoco desearía seguir generando un token nuevo, ya que invalidaría otras llamadas a la API que haya configurado.

En su lugar, puede utilizar OAuth de API para generar de forma temporal lo que se conoce como el Secreto de cliente. Este Secreto de cliente se actualizará cuando pase una hora, lo que significa que dejará de funcionar.

SDK de la aplicación móvil

Para poder poner en marcha el Proyecto de opiniones de la aplicación móvil, hay una integración que debe implementar por su parte. El SDK de la aplicación móvil (Kit para desarrolladores de software) se puede encontrar en las páginas siguientes: