Preguntas frecuentes sobre API de Social Connect

General

¿Cómo habilito mi cuenta de desarrollador?

Para acceder a la API y a las funciones relacionadas, primero debe activar la cuenta de desarrollador. Consulte Preferencias de configuración personal para obtener más información.

¿Cómo comienzo con la API de Social Connect?

Consulte la guía paso a paso de API de conexión social de Qualtrics.

¿Qué tipo de cuenta necesito para utilizar la API de Social Connect?

El acceso a la API no está incluido en todos los planes de precios. Póngase en contacto con el servicio de asistencia de si tiene preguntas sobre lo que incluye su licencia.

¿Tienes una biblioteca de clientes en el lenguaje de programación x?

Qualtrics no ofrece bibliotecas de clientes, pero existen bibliotecas para el protocolo OAuth en casi todos los idiomas; consulte http://oauth.net/code/.

¿Puedo probar rápidamente la API?

Puede probar la API a través de la consola de API. Aquí, seleccionará un punto final y rellenará los parámetros necesarios. Aparecerá un resultado inmediato para que vea si la API resultó en el resultado deseado.

¿Se pueden aumentar los límites de tarifa de API?

Consulte Limitación de tarifa para obtener un resumen de los límites de tarifa de API. Nuestros límites de tarifa actuales son más que suficientes para casos de uso estándar. Sin embargo, si necesita límites de tarifa adicionales, póngase en contacto con el servicio de asistencia de y describa el caso de uso de su aplicación y los límites de tarifa solicitados.

¿Cómo funciona el filtrado en la API?

Varios puntos finales de la API de Social Connect le permiten pasar un parámetro de cadena de filtro.

Por ejemplo, supongamos que está obteniendo una lista de menciones. Puede filtrar las menciones para que solo se devuelvan las menciones con una etiqueta determinada.

El parámetro de filtro siempre es una cadena. Su sintaxis admite la búsqueda de varias propiedades de los datos (palabras mencionadas, etiquetas, estado, tiempo de resolución, etc.) y combinarlas con una sintaxis booleana y anidada.

Cuando crea un filtro en la plataforma Social Connect, el filtro tiene una representación textual asociada. Esta representación aparecerá en la ventana de filtro después de seleccionar los campos de filtro. Puede copiar este parámetro para utilizarlo en sus llamadas API.

¿Qué método se utiliza para firmar webhooks?

Consulte Webhooks para obtener más información.

¿Por qué tengo una tarifa limitada a 20 llamadas API por hora?

Si utiliza la Consola de API, el límite de tasa es de 20 llamadas autenticadas por hora, en lugar de las 350 llamadas por hora estándar para otros clientes de API. Si está experimentando este límite de 20 llamadas, asegúrese de que está utilizando el token de acceso para su aplicación API, no la Consola API.

Autenticación de API

¿Cómo se autentican las llamadas API?

Qualtrics utiliza el protocolo OAuth 2.0 estándar. Consulte Autenticación para obtener más información.

¿Realmente necesito implementar OAuth para mi aplicación?

Si no necesita que los usuarios de su aplicación autentiquen su cuenta de Qualtrics Social Connect, puede generar un token OAuth para su propia cuenta de usuario. Vaya al resumen de la aplicación, haga clic en Editar junto a su aplicación registrada y vaya a la pestaña Tokens de acceso. Si hace clic en Autorizarme a mí mismo, se generará un token de acceso para su usuario que ha iniciado sesión actualmente (con sus permisos). Puede utilizar este token de acceso para firmar solicitudes de API.

¿Durante cuánto tiempo son válidos los tokens de acceso?

Consulte la página Autenticación para obtener más información.

¿A qué cuentas y datos puedo acceder con un token?

Se genera un token de acceso OAuth para un usuario específico de Social Connect. Este usuario tiene acceso a una o más cuentas (puede ver cuáles a través del punto de acceso `/me/account`). Los datos a los que puede acceder dependen de las cuentas a las que tenga acceso el propio usuario y de su rol de usuario en esa cuenta.

Trabajar con menciones

¿Cómo puedo obtener menciones de mi bandeja de entrada de Social Connect en mi propia aplicación?

Use el extremo `/{account_id}/inbox/mentions` para recuperar todas las menciones en cualquiera de sus temas. Esta página de soporte de API cubre la información que se recupera para sus menciones.

También puede diseñar un flujo de trabajo para llamar enlaces web en su aplicación utilizando la función de receta de automatización de Social Connect.

¿Por qué a los Tweets devueltos por la API les faltan detalles?

Para Tweets, Qualtrics solo puede devolver los datos específicos de Social Connect y el ID de Tweet de Twitter. Esta es una restricción de los Términos de la API de Twitter.

Dado que tiene el ID de Tweet, puede acceder a la API de Twitter y utilizar el extremo “/status/lookup” para obtener todos los detalles.

¿Por qué algunas publicaciones de Facebook son anónimas?

Las publicaciones públicas de Facebook (recogidas por Social Connect a través de su búsqueda por palabras clave, no mensajes en sus páginas de Facebook) son anónimas. Esta es una limitación de la API de Facebook.

¿Puedo añadir mis propios mensajes a Social Connect?

Si tiene un formulario de contacto o un foro interno que desea ver supervisado por Social Connect, puede llamar al punto de acceso “/{account_id}/inbox/add” para añadir sus mensajes personalizados a Social Connect. Estos mensajes serán accesibles en su bandeja de entrada y análisis.

Los mensajes añadidos a Social Connect a través de la API no se pueden contestar desde Social Connect Si desea tener esta integración más estrecha con su sistema personalizado, póngase en contacto con Soporte.

¿Puedo exportar casos a través de la API?

Puede utilizar el punto final de mención regular (exportar lista/actualizar mención individual) para exportar casos. Si solo desea devolver casos en su solicitud, puede utilizar el filtro “sub_category:case”.

¿Cuál es la diferencia entre casos y menciones para la API?

En Social Connect una “mención” es el objeto central de un mensaje (un solo tweet, un solo mensaje privado, un solo comentario). También está el concepto de un “caso” que básicamente es una colección de menciones.

El uso principal de los casos es agrupar varios mensajes de un determinado usuario y las respuestas de los agentes en conversaciones.

Desde una perspectiva técnica, una “conversación de caso” consiste en:

• El caso en sí (que también es un objeto de mención).
• Un caso puede tener etiquetas, un estado, un título, etc.
• Una lista de menciones que forman parte de la conversación.
• Las menciones que se han agrupado en el caso.

Consulte esta página de soporte de API para obtener más información sobre casos y menciones.

¿Puedo importar mensajes a la bandeja de salida de Social Connect?

Puede crear borradores de nuevas publicaciones para que los gestores sociales verifiquen, editen y publiquen a través del extremo “/{account_id}/publisher/add”.

¿Puedo editar una mención mediante la API?

Puede editar las menciones existentes utilizando el punto final “/{account_id}/inbox/mencionar/{topic_id}/{id}”. La documentación para este punto final tiene ejemplos para actualizar las etiquetas de una mención, añadir una nota y más.

¿Cómo borro todos los datos de un determinado usuario en Engage mediante la API?

Si desea borrar todos los datos de un cliente determinado que se encuentra en su cuenta de Social Connect, debe borrar dos tipos de datos:

1. Todas las menciones de ese usuario en el sistema
2. Cualquier información sobre ese usuario que se almacena en Social Connect CRM.

Para buscar todas las menciones de un determinado usuario, utilice el punto final “/{account_id}/inbox/mentions” y filtre por un ID de autorización determinado, p. ej. “author.id:123”.Una vez que tenga esa lista de menciones, las menciones se pueden eliminar mediante el extremo “/{account_id}/inbox/mencionar/{topic_id}/{id}”.

Para saber si sus agentes han grabado o no más datos de contacto en Social Connect CRM para un contacto, realice una solicitud GET a “/{account_id}/inbox/contact/{service}/{service_id}”. Si el objeto de respuesta contiene un ID de contacto, significa que hay un contacto para este usuario. Si la respuesta no contiene una propiedad contact.id, significa que no se han almacenado datos en Social Connect CRM.

Una vez que tenga un contact.id, puede realizar una solicitud DELETE en el punto final /{account_id}/inbox/contact/{contact_id} para eliminar toda la información.

Trabajar con contactos  ​

¿Cómo puedo encontrar los detalles de contacto de una mención o caso?

Si la API devuelve una mención o un caso, contendrá una lista de objetos “action_link”. Los enlaces de acción contienen información para el objeto actual sobre qué otros puntos finales de API o URL de la aplicación web son relevantes para este objeto. Para menciones y casos, uno de los enlaces de acción incluidos es donde puede obtener los datos de contacto del autor de la mención o caso.

Al utilizar el punto final /{account_id}/inbox/cases, el objeto de contacto del autor de la mención se incluye de forma predeterminada. Qualtrics no incluye el objeto de contacto completo para las menciones, pero a través de los enlaces de acción este objeto se puede recuperar realizando una llamada API separada.

Publicando

¿Puedo utilizar la API de Clarabridge Engage para publicar en un canal social?

No, la API no permite la publicación directa en plataformas de terceros. Esto significa que no puede utilizar la API de Social Connect para publicar un tweet o un comentario de Facebook.

Sin embargo, puede utilizar la API de Social Connect para crear borradores o mensajes de cola para su aprobación. Estas se publicarán cuando se aprueben o publiquen a través de la interfaz de Social Connect. El punto final para borradores de mensajes es /{account_id}/publisher/add.

Gestión de usuarios

¿Puedo modificar el estado de los usuarios mediante la API?

No, no puede modificar el estado de los usuarios mediante la API. Si bien no puede modificar el estado, puede modificar el nombre, la empresa, el correo electrónico, el avatar y la programación de horas laborables mediante el punto final /{account_id}/settings/user/{id}.

¿Puedo modificar el rol de usuario de los usuarios mediante la API?

Es posible modificar el rol de usuario de un usuario a través de nuestra API. Sin embargo, por motivos de seguridad, no es posible cambiar un rol de usuario a Administrador. Todos los demás roles de usuario están disponibles para cambiar a a través del punto final /{account_id}/settings/user/{id}.

¿Puedo crear nuevos usuarios a través de la API?

Por motivos de seguridad, esto no es posible mediante la API.

Trabajar con perfiles sociales

¿Puedo recuperar información sobre los perfiles sociales en mis temas?

Puede obtener información sobre un determinado perfil social mediante el punto final “/{account_id}/inbox/contact/{service}/{service_id}”. Esto incluirá cualquier detalle que haya rellenado para esa persona dentro de Social Connect CRM, como sexo, correo electrónico o atributos personalizados que haya agregado para este usuario.

Trabajar con análisis

¿Puedo obtener estadísticas de Clarabridge Engage?

Puede extraer datos de Insights utilizando 2 puntos finales de API diferentes;

1. El punto final “/{account_id}/dashboards/export/{dashboard_id}” devuelve los datos de todos los widgets de un determinado dashboard. Una vez que usted o sus usuarios hayan configurado dashboards personalizados, puede utilizar este punto final para obtener los datos detrás de ellos.
2. El punto final “/{account_id}/insights/facets” actúa como el equivalente de API de la función Creador de gráficos en Social Connect.

Problemas

¿Dónde puedo encontrar mi ID de cuenta?

Una vez autenticado, puede obtener una lista de todas las cuentas (y sus ID) a las que tiene acceso un usuario a través del punto de acceso “/me/Accounts”.

¿Dónde puedo encontrar mi ID de tema?

Una vez autenticado, puede obtener una lista de todos los temas (y sus ID) a los que tiene acceso un usuario a través del punto de acceso “/me/Accounts”.

¿Dónde puedo encontrar mi ID de usuario?

Una vez autenticado, puede obtener detalles sobre el usuario de autenticación (incluido su ID) mediante el punto final “/me”.