Tiempo de lectura 3min

API Kibi

Traducción automática

La API REST de Kibi permite que aplicaciones externas, asistentes de IA y automatizaciones accedan a los datos de Kibi Connect. A través de la API, se pueden leer y escribir contenidos, desde páginas wiki, pasando por entradas de noticias, hasta tareas y eventos de calendario.

#Activar acceso a la API

La API REST debe ser activada primero por un administrador del sistema. La configuración se encuentra en:

Configuración → Integraciones → API REST

Aquí están disponibles las siguientes opciones:

  • Activar API REST

    Activa o desactiva la interfaz de la API.

  • Restringir la creación de tokens a ciertos roles

    Si está activado, solo los usuarios con los roles seleccionados pueden crear tokens de API. Además, usuarios individuales pueden ser autorizados a través del acceso a funciones en la pestaña de seguridad de su perfil.

  • Activar restricción por IP

    Si está activado, solo las direcciones IP especificadas podrán acceder a la API. Esto es una capa adicional de seguridad.

Captura de pantalla: Configuración de la API en Integraciones

#Crear token de API

Cada usuario puede crear sus propios tokens de API a través de su perfil de usuario. Para ello, navegue a:

Perfil de usuario → Integraciones → Crear nuevo token

Al crear un token, debe asignar:

  • Nombre

    Un nombre descriptivo (por ejemplo, "Agente de IA", "Integración ERP", "Automatización de flujos de trabajo").

  • Permisos (Scopes)

    Seleccione solo los permisos que la integración realmente necesite (principio de mínimo privilegio).

  • Fecha de caducidad (opcional)

    Opcionalmente, se puede establecer una fecha de caducidad después de la cual el token se invalidará automáticamente.

Captura de pantalla: Formulario de creación de token con scopes

#Guardar el token de forma segura

Después de crearlo, el valor del token se muestra solo una vez. Copie este valor de inmediato y guárdelo de forma segura (por ejemplo, en un gestor de contraseñas). En caso de pérdida, el token debe ser revocado y se debe crear uno nuevo.

Captura de pantalla: Token después de su creación, visible solo una vez

#Permisos disponibles (Scopes)

Los siguientes scopes controlan el acceso del token de API a diferentes áreas:

Scope

Descripción

posts:read

Leer entradas publicadas y noticias

posts:write

Crear, actualizar y eliminar entradas

wiki:read

Leer páginas wiki y documentación

wiki:write

Crear y actualizar páginas wiki

calendar:read

Leer entradas de calendario

calendar:write

Crear, actualizar y eliminar entradas de calendario

groups:read

Leer grupos públicos, miembros, entradas y archivos

surveys:read

Leer encuestas y resultados

tasks:read

Leer tareas (solo propias o asignadas)

tasks:write

Crear y actualizar tareas

users:read

Leer el directorio público de usuarios (sin datos privados)

chat:read

Leer conversaciones y mensajes

chat:write

Enviar mensajes (para bots y automatizaciones)

notifications:read

Leer notificaciones de usuario

notifications:write

Enviar notificaciones a usuarios (incluyendo push)

search

Búsqueda transversal de entidades

#Autenticación de la API

Todas las solicitudes a la API deben incluir el token como Bearer Token en el encabezado Authorization:

curl -H "Authorization: Bearer kbc_SuTokenAquí" \
     https://su-empresa.kibi.de/api/v1/wiki

La URL base de la API es: https://su-empresa.kibi.de/api/v1

#Endpoints disponibles

La documentación completa de la API con todos los endpoints y parámetros está disponible directamente en Kibi Connect en:

  • Documentación interactiva: Perfil de usuario → Integraciones → Documentación de la API

  • Especificación OpenAPI (JSON): Perfil de usuario → Integraciones → OpenAPI JSON

Resumen de los endpoints más importantes:

Área

Endpoint

Descripción

Wiki

GET /wiki

Listar páginas wiki

Wiki

POST /wiki

Crear página wiki

Noticias

GET /posts

Listar entradas

Tareas

GET /tasks

Listar tareas

Calendario

GET /calendar/events

Listar entradas de calendario

Chat

POST /chat/direct

Enviar mensaje directo

Usuarios

GET /users

Listar directorio de usuarios

Búsqueda

GET /search

Búsqueda de texto completo transversal a entidades

#Gestionar tokens

Todos los tokens creados se muestran en la vista general bajo Perfil de usuario → Integraciones. Aquí puede ver:

  • El nombre del token

  • Los permisos asignados

  • Cuándo se usó el token por última vez

  • La opción de revocar un token

Captura de pantalla: Vista general de tokens activos

#Indicaciones importantes

  • Acceso a datos: Los tokens de API solo tienen acceso a los datos a los que el usuario respectivo también tiene acceso. Los permisos del usuario siguen aplicando.

  • Seguridad: Nunca comparta tokens de API públicamente. Guarde los tokens en variables de entorno o en un gestor de secretos, no en el código fuente.

  • Mínimo privilegio: Asigne solo los permisos mínimos necesarios. Un token para una integración wiki no necesita acceso al chat.

  • Fecha de caducidad: Para integraciones temporales, establezca una fecha de caducidad para aumentar la seguridad.

  • Revocación: Revoque inmediatamente los tokens que ya no sean necesarios a través de la vista general de tokens.