API FO Main MyGuichet.lu

Die API „Front Office Main MyGuichet.lu“ dient als zentrale Schnittstelle für alle „FO MyGuichet.lu“-APIs. Sie ermöglicht insbesondere:

• die Verfügbarkeit der „FO MyGuichet.lu“-APIs zu überprüfen;
• die für die Aktionen der anderen „FO MyGuichet.lu“-APIs erforderlichen Zugangstoken abzurufen;
• temporäre Dateien zu senden, die in den anderen „FO MyGuichet.lu“-APIs wiederverwendet werden können.

Die API „FO Main“ ist der zentrale Einstiegspunkt für alle „FO MyGuichet.lu“-APIs.

Hauptfunktionen

Überprüfung des Status des Dienstes

Ermöglicht die Überprüfung der Betriebsbereitschaft von Server und erforderlichen Komponenten (Datenbank, Proxy usw.) über die Endpunkte „ping“ und „health“.

Verwaltung der Zugriffe

Ermöglicht den Erhalt eines GuFoApiAccessToken, der für die Nutzung bestimmter APIs und die Ausführung spezifischer Aktionen unerlässlich ist. Durch diese Überprüfung wird sichergestellt, dass der Client zur Durchführung des gewünschten Vorgangs berechtigt ist.

Verwaltung der temporären Dokumente

Ermöglicht das Senden temporärer Dateien, damit diese von anderen APIs (z. B. der API „FO Procedure MyGuichet.lu“) integriert werden können.

Funktion innerhalb des „FO MyGuichet.lu“-Ökosystems

Die API „FO Main“ muss immer vor den anderen FO-APIs aufgerufen werden, da:

• sie die für die nachfolgenden Aktionen erforderlichen Tokens bereitstellt;
• sie die Zugriffsrechte validiert;
• sie die für die Vorgänge bestimmten Dateien vorübergehend speichert.

Sie bildet somit den Grundbaustein für alle Front-Office-Integrationen.