Resumen: Esta guía está dirigida a desarrolladores, arquitectos de TI e integradores de sistemas que desean crear aplicaciones personalizadas, conectar software externo o automatizar flujos de trabajo con la API de Speakap. Te dirige a la documentación oficial para desarrolladores y ofrece una visión general de lo que la API puede hacer.
Dónde encontrar la documentación técnica
El lugar principal para planificar, construir y desplegar integraciones personalizadas es el Portal para Desarrolladores de Speakap en developer.speakap.io. Allí puedes explorar ejemplos de payloads en vivo, ver rutas de endpoints actualizadas y seguir tutoriales de código.
Capacidades principales de la API de Speakap
El portal para desarrolladores proporciona referencias extensas e interactivas para nuestra API pública RESTful. Puedes usarla para construir sincronizaciones bidireccionales de datos entre los objetos principales en Speakap:
- Usuarios: Proveer datos de usuarios, obtener identificadores únicos hexadecimales de 64 bits (EIDs) y auditar perfiles de empleados. Nota: un EID no es lo mismo que un XID. Un EID es el identificador interno usado dentro de Speakap, mientras que un XID es el identificador externo que vincula a un usuario en Speakap con un sistema externo, como una base de datos de RRHH.
- Grupos: Mapear grupos organizacionales básicos, restringidos, privados o jerárquicos para que coincidan con la estructura interna de tu empresa.
- Mensajes: Consultar recursos que incluyen actualizaciones en el Feed, comentarios, mensajes de chat privados, noticias y cargas de archivos.
- Notificaciones: Enviar notificaciones push personalizadas y activar alertas de usuario cuando ocurran eventos importantes en sistemas de terceros.
Autenticación, manifiestos y despliegue de aplicaciones
Para proteger los datos de tu red contra usos no autorizados, todas las funciones personalizadas se conectan a través de capas estándar de seguridad y configuración:
- OAuth 2.0: Las aplicaciones autorizan solicitudes usando Tokens de Acceso de corta duración y Tokens de Actualización de largo plazo, gestionados a través del autenticador central de Speakap.
- Manifiestos de aplicaciones JSON: Los desarrolladores definen puntos de integración, conjuntos de permisos y ubicación en la interfaz de usuario subiendo un archivo estándar de definición manifest.json.
- El Mercado de Speakap: Una vez que una herramienta interna está verificada, un administrador de red puede iniciar sesión en un navegador de escritorio e instalar la aplicación a través de la pestaña App Market en Network Settings. La aplicación puede ser visible solo para tu propia organización o publicada globalmente en el Mercado público de Speakap.
Preguntas frecuentes
¿Dónde puedo encontrar la documentación oficial de la API de Speakap y las especificaciones OpenAPI?
Puedes explorar los esquemas de los endpoints y descargar la última versión de nuestra definición pública OpenAPI en el Portal para Desarrolladores de Speakap.
¿Qué estándar de autenticación usa la plataforma para asegurar las integraciones de terceros?
Speakap utiliza el protocolo estándar de la industria OAuth 2.0 junto con solicitudes firmadas para autenticar de forma segura las conexiones de clientes, pasando tokens para identificar acciones de API en nombre de aplicaciones o usuarios.
¿Cómo despliego una aplicación personalizada en nuestra red?
Construye tu aplicación usando las directrices del manifiesto JSON en el portal para desarrolladores. Una vez lista, un administrador de red puede iniciar sesión en un navegador de escritorio e instalarla a través de la pestaña App Market en Network Settings.
¿Qué son los EIDs y cómo se usan?
Un EID es un identificador interno representado como un entero hexadecimal único de 64 bits asignado a cada objeto individual en la base de datos del sistema. Proporcionas estos EIDs en los encabezados y parámetros de consulta de tus solicitudes API para buscar o actualizar elementos como registros específicos de usuarios o noticias. En contraste, un XID es el identificador externo usado para vincular a un usuario en Speakap con un sistema externo, como una base de datos de RRHH.
¿Aún tienes dudas?
Envíanos un correo a technicalimplementations@speakap.nl con el nombre de tu red y una descripción de lo que estás construyendo, y te ayudaremos.