API FO Main MyGuichet.lu

L’API Front Office Main MyGuichet.lu constitue le point d’entrée unique pour l’ensemble des API FO MyGuichet.lu. Elle permet notamment :

• de vérifier la disponibilité des API FO MyGuichet.lu ;
• d’obtenir des tokens d’accès nécessaires aux actions des autres API FO MyGuichet.lu;
• d’envoyer des fichiers temporaires réutilisables dans les autres API FO MyGuichet.lu.

L’API FO Main est le point d’entrée central pour toutes les API Front Office de MyGuichet.lu.

Fonctionnalités principales

Vérification du statut du service
Permet de vérifier que le serveur et les composants nécessaires (base de données, proxy, etc.) sont opérationnels via les endpoints ping et health.

Gestion des accès
Permet d’obtenir un GuFoApiAccessToken, indispensable pour consommer certaines API et exécuter des actions spécifiques. Ce contrôle garantit que le client est autorisé à effectuer l’opération demandée.

Gestion des documents temporaires
Permet l’envoi de fichiers temporaires afin qu’ils puissent être intégrés par d’autres API (ex. API FO Procedure MyGuichet.lu).

Rôle dans l’écosystème FO MyGuichet.lu

L’API FO Main doit toujours être appelée avant les autres API FO, car :

• elle délivre les tokens nécessaires à la suite des actions ;
• elle valide les droits d’accès ;
• elle stocke temporairement les fichiers destinés aux démarches.

Elle constitue donc la brique fondamentale pour toutes les intégrations Front Office.