Liste des API proposées par EFR
2 types d’API sont exposées par EFR:
les API partagées et communes à tous les environnements
les API spécifiques à 1 environnement.
Les contrats OpenAPI sont accessibles depuis l’IHM. Exemple:
...
API communes
API | Objectifs | URL |
|---|---|---|
Keycloak | Gestion des identités | [domaine]/auth/ |
Business | Notions de cartographie: couche métier | [domaine]/api/business/1 |
Applications | Notions de cartographie: couche applications | [domaine]/api/applications/1 |
Mediations | Notions de cartographie: couche médiations (flux) | [domaine]/api/mediations/1 |
Encrypt | Chiffrement des contenus | [domaine]/api/encrypt-internal/1 |
NRTests | [domaine]/api/nrtests/1 | |
Properties | [domaine]/api/properties/1 | |
API d’environnement
API | Objectifs | URL |
|---|---|---|
Traces | Traces de transport | [domaine]/[environnement]/api/traces/1 |
Runtime | Moteur de rapprochement | [domaine]/[environnement]/api/runtime/1 |
Runtime statistics | Statistiques du moteur de rapprochement | [domaine]/[environnement]/api/runtime-statistics/1 |
Dynamic tables | Gestion des Tables de données dynamiques | [domaine]/[environnement]/api/transcodifications/1 |
Alerts | Alertes des échanges levées par les erreurs | [domaine]/[environnement]/api/alerts/1 |
Authentification préalable
Une authentification OpenID Connect est nécessaire.
Elle se passe en la récupération d’un token. Il est valide plusieurs heures (à configurer).
La requête est caractérisée par:
URL: [domaine]/auth/realms/efr/protocol/openid-connect/token
Méthode POST
Content type: application/x-www-form-urlencoded
Contenu: username=[ ]&password&[ ]&grant_type=password&client_id=[ ]&client_secret=[ ]
| Info |
|---|
Demander ces informations au support EFR. |
La réponse est une réponse JSON avec le token:
| Bloc de code | ||
|---|---|---|
| ||
{
"access_token": "<token>",
"expires_in": 1800,
"refresh_expires_in": 36000,
"refresh_token": "...",
"token_type": "Bearer",
"not-before-policy": 1626195491,
"session_state": "a4e15b01-a65a-4813-8aeb-06d9159c783a",
"scope": "email roles profile"
} |
Le token est à utiliser pour tous les appels API. Un header Authorization doit être joint à chaque requete HTTP:
| Bloc de code |
|---|
Authorization: Bearer <token> |