Instalación personalizada de Launchpad v1
Obtenga más información sobre nuestro proceso de instalación personalizado de Launchpad.
¡Echa un vistazo a Launchpad v2!
Echa un vistazo a nuestro nuevo y mejorado launchpad . La misma gran funcionalidad ahora está disponible para todos los planes. ¡ pin tu centro de recursos en la aplicación sin necesidad de modificar un solo código!
Una vez que haya decidido usar Launchpad, puede decidir qué método de instalación usará según el grado de personalización que desee. La instalación personalizada de Launchpad ofrece las siguientes características:
- La dificultad de implementación depende de las funcionalidades que desea incluir (¿tiene prisa por una implementación rápida de Launchpad? ¡Pruebe nuestra instalación estándar de Launchpad!)
- Personalización COMPLETA (¿quieres agregar un widget o redirigir a los usuarios a una página? ¡Es posible!)
Un ejemplo sería nuestra propia baliza de "Ayuda" en Studio. Puedes leer más sobre cómo usamos Launchpad en este artículo: Cómo usamos Launchpad para crear un centro de recursos.
Proceso de instalación
El método de instalación personalizada solo ofrece API para que tu equipo de desarrollo pueda implementar el Launchpad según las preferencias de tu aplicación, lo que permite un control total sobre su apariencia. No se requieren plantillas de instalación para este método, ya que deberás crearlo tú mismo debido a su naturaleza personalizada.
Introducción
La API Appcues proporciona un punto final HTTP para acceder a todo el contenido que un usuario está calificado para ver dentro del Launchpad Appcues .
Conectando
La URL raíz de la API Appcues es https://api.appcues.com/.
La URL para obtener la lista de contenido se forma utilizando el ID de su cuenta de Appcues (visible desde la página de su cuenta de Appcues ) y el ID del usuario final (el primer parámetro del código de su sitio). Llamada .identify() de Appcues ), de la siguiente manera:
https://api.appcues.com/v1/accounts/{account_id}/users/{user_id}/launchpad
Formato de solicitud
El punto final de actividad del usuario solo acepta solicitudes GET.
La solicitud debe contener el siguiente parámetro de consulta:
URL: La URL de la página actual del usuario. Se utiliza para el filtrado a nivel de página y debe estar completamente codificada para garantizar una respuesta precisa. Para realizar pruebas rápidas, un codificador de URL como https://meyerweb.com/eric/tools/dencoder/ puede ser útil.
Un ejemplo sería:
https://api.appcues.com/v1/accounts/{account_id}/users/{user_id}/launchpad?url=https://yoursite.com/dashboard
Encabezados de solicitud
El encabezado de autorización es obligatorio si su cuenta utiliza la verificación de identidad . Debe incluir la firma del ID de usuario y usar el siguiente formato:
Authorization: Bearer {user id signature}
Formato de respuesta
Un envío exitoso de actividad de usuario dará como resultado una respuesta con el código de estado 200 y un cuerpo de respuesta como el siguiente:
{"request_id":"abc123","contents":[]}
request_id Request_id especificado en la solicitud, si lo hay.
Contenido: Una matriz de contenido para la que el usuario califica actualmente. Usado internamente por el SDK Appcues ; usuarios externos pueden ignorarlo.
Ejemplo de respuesta de lo que podría recibir (la respuesta real puede variar):
{
"checklists":[
],
"contenido":[
{
"atributos":{
"creado_en":1646163441985,
"creado_por":"uRAZUSQ2mDdNDkJMTAs4u3IEmA62",
"id":"3211a0f6-ff2f-4feb-97a4-5fe994b8a25e",
"nombre_interno":null,
"nombre":"Localización" Prueba",
"estado":"PUBLICADO",
"pasos":{
"34a19398-4dbb-4b1c-acd2-5f675e7c3afb":{
"id":"34a19398-4dbb-4b1c-acd2-5f675e7c3afb",
"índice":1,
"paso":{
"atributos":{
"telóndefondo":falso,
"telóndefondo_borde_sólido":falso,
"opacidaddelbordesólidodelfondo":0,5
"beacon_style":"oculto",
"hotspots":[
{
"radiodelbordedelbordesólidodelfondo":0.0,
"telóndefondo_borde_sólido_relleno_x":0.0,
"telóndefondo_borde_sólido_relleno_y":0.0,
"selectores_de_copia_de_seguridad":null,
"ocultar_botón_siguiente":verdadero,
"html":"sinprocesar" html de paso",
"id":"a21b1c23-be6a-4551-9193-cfbbda121398",
"índice":0,
"next_text":"Siguiente",
"desplazamiento_x_porcentaje":0,08125707814269535,
"desplazamiento_y_porcentaje":0,09948320413436693,
"patrón":nulo,
"selector":".establecedordepropiedades p:n-ésimo-de-tipo(1)",
"configuración_del_selector":{
"selector":".establecedordepropiedades p:n-ésimo-de-tipo(1)"
},
"skip_text":"Ocultar" estos consejos",
"tooltip_alignment":null,
"condiciones_ui":{
"siguiente":nulo
},
"z_index_override":nulo
}
],
"secuencial":verdadero,
"omitible":verdadero,
"tipo_de_visualización_omitible":"texto",
"estilo":null
},
"creado_en":1646163441992,
"flow_id":nulo,
"id":"34a19398-4dbb-4b1c-acd2-5f675e7c3afb",
"migrado_desde_paso_id":nulo,
"nombre":null,
"next_content_id":nulo,
"parent_id":null,
"redireccionar_nueva_pestaña":falso,
"url_de_redirección":nulo,
"tipo":"grupodehotspot",
"actualizado_alas":1646163441992,
"id_de_versión":1646163441992
},
"step_type":"grupodehotspot"
},
"a7bb2572-f410-4bf2-b672-91943bd6ac9e":{
"id":"a7bb2572-f410-4bf2-b672-91943bd6ac9e",
"índice":0,
"paso":{
"atributos":{
"telóndefondo":verdadero,
"is_progress_bar_hidden":falso,
"tipo_de_patrón":"modal",
"posición":"arriba",
"omitible":verdadero,
"pasos":[
{
"acciones_ocultas":falso,
"html":"sinprocesar" html de paso",
"id":"f2bf8d53-05c2-4d51-ad3d-f821b4d46986",
"está_centrado_el_botón":verdadero,
"botón_siguiente_oculto":falso,
"next_text":"Vamos ¡ir!",
"prev_button_hidden":falso,
"prev_text":"Cancelar",
"botones_de_paso":[
],
"número_de_paso":1,
"condiciones_ui":{
}
}
],
"estilo":null
},
"creado_en":1646163441989,
"flow_id":nulo,
"id":"a7bb2572-f410-4bf2-b672-91943bd6ac9e",
"migrado_desde_paso_id":nulo,
"nombre":null,
"next_content_id":nulo,
"parent_id":null,
"redireccionar_nueva_pestaña":falso,
"url_de_redirección":nulo,
"tipo":"modal",
"actualizado_alas":1646163441989,
"id_de_versión":1646163441989
},
"tipo_de_paso":"modal"
}
},
"actualizado_alas":1646163440192,
"actualizado_por":"uRAZUSQ2mDdNDkJMTAs4u3IEmA62",
"version_id":nulo
},
"contexto":{
"locale_id":"predeterminado",
"locale_name":"predeterminado"
},
"creado_en":1646163441985,
"versión_de_formato":2,
"id":"3211a0f6-ff2f-4feb-97a4-5fe994b8a25e",
"migrado_desde_paso_id":nulo,
"nombre":"Localización" Prueba",
"next_content_id":nulo,
"parent_id":null,
"redireccionar_nueva_pestaña":falso,
"url_de_redirección":nulo,
"tipo":"viaje",
"actualizado_alas":1646163440192,
"id_de_versión":1646163440192
}
],
"experiencias":[
],
"calificación_realizada":verdadero,
"perfil":{
"_ABGroup":2
},
"motivo_de_calificación":null,
"id_de_solicitud":nulo
}