Skip to main content
Aquest document descriu els passos necessaris per fer les primeres crides a l’API de Flexxible.

​
Entorns

L’accés a l’API pot variar en funció de l’entorn.

​
URL base

Totes les rutes de l’API es construeixen a partir d’aquesta base: Flexxible
FXXOne

​
Generar una clau d’API

Per crear aquesta clau és necessari que l’usuari tingui el rol d’Administrador d’organització.
  1. Accedir a Configuració → Organització.
  2. Seleccionar la pestanya Claus d’API.
  3. Fer clic a Crear clau d’API.
  4. Emplenar el formulari.
    • Nom. Identificador de la clau API.
    • Rol. Rol assignat a l’usuari a Portal.
    • Durada. Temps de validesa de la clau.
  5. Confirmar amb Desa.

​
Autenticar les sol·licituds

Totes les peticions han d’incloure la clau a la capçalera Authentication utilitzant l’esquema Bearer: Authentication: Bearer <api_key> Tot i que s’utilitza l’esquema Bearer, el valor correspon directament a una clau d’API generada a la plataforma 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 la ruta. https://api.flexxible.net/v2/organizations/:organization_id/{endpoint} Per trobar l’ID de l’organització:
  1. Accedir a Configuració → Organització.
  2. Seleccionar la pestanya General → Detalls.
  3. Copiar l’identificador.

​
Contracte OpenAPI

Descarrega 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 manera predeterminada a tots els entorns.