Primeros pasos
Este documento describe los pasos necesarios para realizar las primeras llamadas a la API de Flexxible.
Entornos
El acceso a la API puede variar en función del entorno.
URL base
Todas las rutas de la API se construyen a partir de esta base:
https://api.one.flexxible.net
Generar una clave de API
Para crear esta clave es necesario que el usuario tenga rol de Administrador de organización.
-
Acceder a Portal.
-
En el menú lateral, hacer clic en
Configuración→Organización. -
Seleccionar la pestaña
Claves de API.
-
Hacer clic en
Crear clave de API. -
Completar el formulario.
- Nombre. Identificador de la clave API.
- Rol. Rol asignado al usuario en Portal.
- Duración. Tiempo de validez de la clave.
-
Confirmar con
Guardar.
Autenticar las solicitudes
Todas las peticiones deben incluir la clave en la cabecera Authentication utilizando el esquema Bearer:
Authentication: Bearer <api_key>
Aunque se utiliza el esquema Bearer, el valor corresponde directamente a una clave de API generada en Portal, y no a un token obtenido mediante un proceso de autenticación adicional.
Obtener el ID de la organización
Cada endpoint requiere el ID de la organización como primer segmento de ruta.
https://api.flexxible.net/v2/organizations/:organization_id/{endpoint}
Para encontrar el ID de la organización:
-
Acceder a
Portal->Configuración->Organización. -
Seleccionar la pestaña
General->Detalles. -
Copiar el identificador.
Contrato OpenAPI
Descargar el contrato OpenAPI en formato JSON para consultar la especificación completa de la API y facilitar las integraciones.
Límites
Para garantizar la estabilidad, el rendimiento y la disponibilidad del servicio, la plataforma aplica límites lógicos al número máximo de elementos que un tenant puede almacenar de cada entidad disponible en la API. Estos límites no corresponden a límites de peticiones a la API (rate limits) sino que definen la cantidad máxima de elementos de cada tipo de entidad que un tenant puede tener en un momento dado.
Dichos límites se aplican de forma predeterminada en todos los entornos.
| Entidad | Límite de elementos |
|---|---|
| Tenants y tenants delegados | 100 |
| Organizaciones | 100 |
| Grupos de reporte | 500 |
| Grupos de workspaces | 1000 |
| Grupos de workspaces → Programación | 10 |
| Flujos | 100 |
| Microservicios | 500 |
| Informes | 500 |
| Web Apps | 100 |
| Webhooks | 100 |
| Licencias | 500 |
| Configuración de alertas | 100 |
| Roles | 100 |
| Usuarios | 1500 |
| Actualizaciones → Directivas | 50 |
| Actualizaciones → Targets | 50 |
| Directivas | 50 |
| Integraciones | 10 |
| Categorías de informes | 100 |
| Categorías de microservicios | 100 |
| Dominios | 5 |
| Integraciones SSO | 5 |
| Productos | 15 |
| Módulos | 50 |
| API Keys | 15 |