API pública Appcues

Appcues ofrece una API que permite realizar diversas tareas, lo que aumenta Appcues versatilidad. La API permite acceder a información de flujo, actualizar segmentos y perfiles de usuario, e importar y exportar datos en masa. Si desea acceder directamente a la documentación técnica, puede hacerlo aquí .

La API Appcues es una API web que ofrece acceso a funciones dentro de la plataforma Appcues . Cada función se identifica mediante un método HTTP y una URL. Todas las solicitudes y respuestas de la API se codifican como JSON por defecto. La mayoría de los puntos finales de la API también admiten la entrada y salida de CSV.

Usando la API

Si bien existen muchos casos de uso para estos puntos finales, algunas de las cosas más interesantes que puede hacer son:

• Obtener datos históricos de eventos y propiedades de usuario en Appcues inmediatamente. Sin usar la API, los datos solo se añadirán conforme se visualicen.
• ¡Usando los puntos finales de segmento para crear segmentos que incluyan más de 1000 usuarios!
• Usar los puntos finales de publicación/cancelación de publicación para iniciar flujos exactamente en el momento correcto sin necesidad de usar Appcues Studio.

Llaves y secretos

Todas las solicitudes a la API V2 Appcues deben autenticarse mediante una clave API y un secreto. Las claves API y los secretos se pueden crear y gestionar en la página de Claves API en studio.appcues.com.

Una vez que llegue a la página de Claves API, verá una lista de todas las claves API existentes y los administradores de cuentas de Appcues también tendrán la posibilidad de crear nuevas claves.

Para crear una nueva clave, seleccione el botón Crear nueva clave.

Una vez que haya hecho clic en el botón, se le solicitará que le dé a su clave un nombre descriptivo y que proporcione el nivel de acceso que desea que tenga su clave.

El siguiente paso te mostrará la clave API y el secreto, con fácil acceso para guardarlos en el portapapeles. Si no puedes usar el secreto inmediatamente, anótalo en algún lugar, ya que NO estará disponible de nuevo.

Si alguna vez necesita ver información adicional sobre la clave (como quién la creó), deshabilitar la clave, eliminar una clave deshabilitada o volver a habilitar una clave deshabilitada, puede hacerlo haciendo clic en el menú más.

Una vez que tenga su clave y secreto, puede usarlos para los puntos finales enumerados a continuación.

NOTA: Para eliminar una clave, primero debe estar deshabilitada.

NOTA: La clave API heredada no se puede eliminar ni deshabilitar, y aún es necesaria para la instalación inicial de Appcues , así como para algunas integraciones.

Flujos

Para los flujos , la API pública Appcues proporciona acceso a

• Lista de flujos de su cuenta
• Detalles del flujo de su cuenta para un solo flujo
• Flujos de publicación
• Despublicación de flujos

Usuarios finales

Para los usuarios finales, la API pública Appcues proporciona puntos finales para

• Obtener el perfil completo de un usuario
• Actualizar el perfil de un usuario
• Obtener los eventos más recientes de un usuario

Segmentos

Para los segmentos , la API pública Appcues proporciona puntos finales para

• Lista de segmentos de su cuenta
• Detalles del segmento de su cuenta para un solo segmento
• La capacidad de crear un segmento
• La capacidad de actualizar un segmento
• La capacidad de eliminar un segmento
• La capacidad de actualizar un segmento agregando un ID de usuario específico
• La capacidad de actualizar un segmento eliminando un ID de usuario específico
  • Eliminar un usuario de un segmento con la API solo funciona si el usuario se agregó con la API

Importación de datos

Para importar datos , la API pública Appcues proporciona puntos finales para

• Importar la actividad de un solo usuario
• Importación masiva de datos de perfiles
• Importación masiva de datos de eventos

Exportación de datos

Para exportar datos , la API pública Appcues proporciona puntos finales para

• Exportación de datos de eventos masivos

Para revisar esta información con más detalle, consulte https://api.appcues.com/v2/docs

Etiquetas

Para las etiquetas , la API pública Appcues proporciona puntos finales para

• Etiquetas de lista de su cuenta
• Detalles de la etiqueta de su cuenta

Grupos

Para los grupos , la API pública Appcues proporciona puntos finales para

• Obtener el perfil de un grupo
• Actualizar el perfil de un grupo
• Asociar usuarios a un grupo

Patas

Para pins , la API pública Appcues proporciona puntos finales para

• La lista de pins de tu cuenta
• Los detalles pin de su cuenta
• pins de publicación
• Anular la publicación pins

Experiencias móviles

Para las experiencias móviles , la API pública Appcues proporciona puntos finales para

• Lista de experiencias móviles de su cuenta
• Detalles de la experiencia móvil de su cuenta
• Publicación de experiencias móviles
• Cancelar la publicación de experiencias móviles

Plataformas de lanzamiento

Para launchpads , la API pública Appcues proporciona puntos finales para

• Lista de launchpads de su cuenta
• Detalles launchpad de su cuenta
• launchpads editorial
• Despublicación launchpads

Banners

Para banners , la API pública Appcues proporciona puntos finales para

• Lista de banners de tu cuenta
• Detalles banners de su cuenta
• Publicación banners
• Anulación de la publicación banners

Listas de verificación

Para checklists , la API pública Appcues proporciona puntos finales para

• Lista de listas de checklists de su cuenta
• Detalles de checklists de su cuenta
• checklists para publicaciones
• checklists para anular la publicación

Capturas de pantalla

Para las capturas de pantalla , la API pública Appcues proporciona puntos finales para

• Obtener capturas de pantalla de Flow o cualquier experiencia

Apoyo

Al contactar al soporte por cualquier problema relacionado con la API, asegúrese de incluir los detalles completos de la solicitud HTTP (por ejemplo, la línea de comando curl utilizada para la solicitud) y el nombre de la clave, pero nunca envíe el secreto de la clave API.

Respuestas de la API pública

Aquí tienes una lista de algunas de las respuestas que la API pública podría devolver. Haz clic aquí para más información.

• 200 - Éxito. La solicitud se realizó correctamente.
• 201 - Creado. La solicitud se realizó correctamente y resultó en la creación de un nuevo recurso.
• 202 - Aceptado. La solicitud fue aceptada y se está procesando sin conexión.
• 400 - Solicitud incorrecta. La solicitud tenía un formato incorrecto o no era válida.
• 401 - No autorizado. Las credenciales de acceso faltaban o no eran válidas.
• 403 - Prohibido. Las credenciales proporcionadas no permiten el acceso al recurso solicitado.
• 404 - No encontrado. No se pudo localizar el punto final o recurso en nuestro sistema.
• 415 - Tipo de medio no compatible. El tipo de contenido especificado en el encabezado "Content-type" no es compatible con esta API.
• 429 - Demasiadas solicitudes. Las solicitudes de esta clave API se están limitando debido al alto tráfico.
• 500 - Error interno del servidor. Algo salió mal y no es tu culpa.