L'API de la plateforme
Les écrans de la plateforme s'appuient sur une API REST au format JSON. Elle permet d'automatiser une lecture de résultats ou un dépôt, avec les droits d'un compte utilisateur (voir Authentification).
La forme des chemins
| Chemin | Usage |
|---|---|
/api/v1/auth/… | connexion, second facteur, renouvellement du jeton |
/api/v1/orgs/<organisation>/… | tout ce qui touche une organisation : données, paramètres, calculs, résultats |
/api/v1/admin/… | la console d'administration, sur une installation hébergée seulement |
/api/v1/health, /api/v1/system/info | l'état du service et le mode de l'installation, sans authentification |
Les routes d'un module fermé à l'organisation sont refusées.
Quelques routes
Les chemins ci-dessous suivent /api/v1/orgs/<organisation>.
| Méthode | Route | Ce qu'elle fait |
|---|---|---|
GET | /services/import/template/model | télécharge le modèle d'import de la zone |
POST | /services/import/template/upload | dépose un classeur (préparé, non publié) |
POST | /services/import/lot/<lot>/commit | publie un lot |
GET | /services/import/positions/arretes | liste les arrêtés qui ont des positions publiées |
GET | /modules/alm/irrbb/synthese | la synthèse IRRBB de l'arrêté |
GET | /modules/alm/liquidite/referentiel | le dernier résultat de liquidité de l'arrêté |
GET | /services/restitutions/catalogue | le catalogue des rapports disponibles |
GET | /services/restitutions/<rapport>/pdf | télécharge un rapport |
Les calculs se créent et se lancent par les routes des études (/etudes/<étude>/evaluations), comme le fait
l'écran Évaluations. C'est aujourd'hui le seul moyen de lancer le calcul des états CERBER.
La description OpenAPI
Le service publie sa description OpenAPI (/openapi.json) et sa documentation interactive (/docs) à la
racine du service applicatif, hors du préfixe /api. Les portes d'entrée des installations ne relaient que
/api/ : demandez à votre équipe d'exploitation un accès direct au service applicatif pour les consulter.