Resumen: Esta guía explica cómo integrar software existente o personalizado en tu red utilizando la API de Speakap. Cubre la configuración técnica para desarrolladores (el archivo manifest.json) e instrucciones paso a paso para que los administradores de red instalen una aplicación y la asignen a grupos específicos. Puedes encontrar más información en developer.speakap.io.
¿Qué es una aplicación Speakap?
Una aplicación Speakap es una aplicación web, generalmente proporcionada por un tercero o desarrollada a medida, que se integra en la plataforma Speakap para ofrecer funcionalidades específicas (como una lista de tareas o software de horarios de trabajo).
Los usuarios acceden a la aplicación desde las apps web o móviles de Speakap, donde está incrustada en un iframe HTML. Una vez integrada, los desarrolladores pueden usar varias partes de la red:
- El Feed y widgets: las aplicaciones pueden publicar actualizaciones automáticas en los feeds o mostrar widgets personalizados (por ejemplo, la lista de tareas del usuario conectado) junto al Feed de la red.
- El menú principal: las aplicaciones pueden añadirse directamente al menú de navegación principal con una etiqueta e icono personalizados (usando el conjunto de iconos Font Awesome).
- Usuarios y grupos: las aplicaciones pueden usar datos del perfil de usuario (nombres, avatares, cargos) y datos de grupos para facilitar la colaboración.
Para desarrolladores: configurar y preparar el manifest
Antes de que un administrador pueda instalar la aplicación, el desarrollador debe configurarla.
Paso 1: Registro. Primero, asegúrate de tener acceso a una red Speakap. Regístrate como desarrollador para que la pestaña Speakap Market esté disponible en la configuración de tu red.
Paso 2: Configurar el manifest.json. Cada aplicación requiere un archivo manifest.json, que especifica metadatos sobre la aplicación. La información más genérica incluye el nombre y el icono, que se usan para listar la aplicación en el Speakap Market.
El núcleo del manifest está formado por las definiciones de las entradas. Se debe proporcionar al menos una entrada para que la aplicación sea visible para los usuarios. Las entradas consisten en:
- Posiciones: dónde aparece la aplicación. Las opciones incluyen main (el menú lateral izquierdo), network-timeline-widget (widgets en la página principal de escritorio), install-wizard (mostrado a los administradores durante la instalación), settings-page (para configuración posterior a la instalación) y *-lightbox (para cargar contenido personalizado en lightbox).
- Dispositivos: los formatos de dispositivo a los que aplica la entrada (teléfono, tableta, escritorio o todos).
- Propiedades: puedes definir la url (cargada mediante una solicitud firmada), permisos requeridos, la etiqueta visible para el usuario (que debe incluir traducciones como "en-US") y el icono.
Para la plantilla completa y una referencia de todas las propiedades, consulta Plantilla y propiedades del manifest de aplicación Speakap.
Para administradores: instalar la aplicación
Una vez que el desarrollador ha preparado la aplicación y la URL del manifest.json, un administrador de red puede instalarla. Para acceder al Speakap Market necesitas una cuenta Speakap activa con rol de administrador.
- Inicia sesión en tu red Speakap.
- Haz clic en tu foto de perfil en la esquina superior derecha de la página.
- Haz clic en Configuración de red, luego en Speakap Market en el menú de la izquierda.
- Haz clic en + Aplicación en la parte superior derecha de la pantalla.
- Selecciona la aplicación deseada de la lista, o copia y pega el archivo manifest.json de tu aplicación personalizada.
- Haz clic en Agregar aplicación.
- Haz clic en Instalar en la red para instalar la aplicación.
Asignar la aplicación a grupos específicos. Las aplicaciones pueden instalarse para toda la red o para audiencias específicas, como Unidades de Negocio, Departamentos o Grupos:
- Si quieres que la aplicación sea visible solo para ciertos miembros, haz clic en Seleccionar grupos en el paso 7 mencionado arriba.
- En la pantalla Seleccionar grupos, elige la audiencia específica para la aplicación.
- Después de seleccionar los grupos deseados, haz clic en Seleccionar para confirmar.
Gestionar aplicaciones instaladas
Los administradores pueden activar, desactivar o editar aplicaciones Speakap en cualquier momento desde el Speakap Market, ubicado en la Configuración de red. Si el Speakap Market no es visible, solicita a tu Customer Success Manager (csm@speakap.com) o envía un correo a support@speakap.com para que te lo habiliten.
Algunas aplicaciones, según cómo fueron desarrolladas, tienen un botón de configuración (rueda dentada junto al icono de la papelera). Haz clic allí para editar la configuración de la aplicación. Para preguntas sobre la configuración de una aplicación, contacta al desarrollador de esa aplicación.
Para eliminar una aplicación más adelante, consulta Cómo eliminar una aplicación del Speakap Market.
¿Aún tienes dudas?
Envíanos un correo a support@speakap.com con el nombre de tu red y el nombre de la aplicación, y te ayudaremos. Para preguntas técnicas sobre la API o tu manifest.json, escribe a technicalimplementations@speakap.nl.