Primers passos
Aquest document descriu els passos necessaris per realitzar les primeres trucades a l'API de Flexxible.
Entorns
L'accés a l'API pot variar segons l'entorn.
URL base
Totes les rutes de l'API es construeixen a partir d'aquesta base:
https://api.one.flexxible.net
Generar una clau d'API
Per crear aquesta clau és necessari que l'usuari tingui el rol d'Administrador d'organització.
-
Accedir a Portal.
-
Al menú lateral, fes clic a
Configuració→Organització. -
Seleccionar la pestanya
Claus d'API.
-
Fes clic a
Crear clau d’API. -
Completa el formulari.
- Nom. Identificador de la clau API.
- Rol. Rol assignat a l'usuari en Portal.
- Durada. Temps de validesa de la clau.
-
Confirma amb
Guardar.
Autentica les sol·licituds
Totes les peticions han d'incloure la clau a la capçalera Authentication utilitzant l'esquema Bearer:
Autenticació: Bearer <api_key>
Encara que s'utilitza l'esquema Bearer, el valor correspon directament a una clau d'API generada a Portal, i no a un token obtingut mitjançant un procés d'autenticació addicional.
Obtenir l'ID de l'organització
Cada endpoint requereix l'ID de l'organització com a primer segment de ruta.
https://api.flexxible.net/v2/organizations/:organization_id/{endpoint}
Per trobar l'ID de l'organització:
-
Accedir a
Portal->Configuració->Organització. -
Seleccionar la pestanya
General->Detalls. -
Copia l'identificador.
Contracte OpenAPI
Descarregar el contracte OpenAPI en format JSON per consultar l'especificació completa de l'API i facilitar les integracions.
Límits
Per garantir l'estabilitat, el rendiment i la disponibilitat del servei, la plataforma aplica límits lògics al nombre màxim d'elements que un tenant pot emmagatzemar de cada entitat disponible a l'API. Aquests límits no corresponen a límits de peticions a l'API (rate limits) sinó que defineixen la quantitat màxima d'elements de cada tipus d'entitat que un tenant pot tenir en un moment donat.
Aquests límits s'apliquen de forma predeterminada en tots els entorns.
| Entitat | Límit d'elements |
|---|---|
| Tenants i tenants delegats | 100 |
| Organitzacions | 100 |
| Grups de report | 500 |
| Grups de Workspaces | 1000 |
| Grups de workspaces → Programació | 10 |
| Fluxos | 100 |
| Microserveis | 500 |
| Informes | 500 |
| Web Apps | 100 |
| Webhooks | 100 |
| Llicències | 500 |
| Configuració d'alertes | 100 |
| Rols | 100 |
| Usuaris | 1500 |
| Actualitzacions → Directives | 50 |
| Actualitzacions → Targets | 50 |
| Directrius | 50 |
| Integracions | 10 |
| Categories d'informes | 100 |
| Categories de microserveis | 100 |
| Dominis | 5 |
| Integracions SSO | 5 |
| Productes | 15 |
| Mòduls | 50 |
| API Keys | 15 |