Interne API/ Schnittstelle

Diese API ermöglicht den Zugriff auf verschiedene Ressourcen. Sie dient u.a. der Verwaltung von Daten und Interaktionen zwischen Frontend und Backend.

Verfügbare Endpunkte

Endpunkt	Beschreibung	Methoden	Erforderliche Header
/api/main/platform/licenses	request available licensing models.	GET	/
/api/main/platform/groups	request available user groups.	GET	/
/api/main/files	handle all type of files.	GET, PUT	X-FILE-Section
/api/main/structure/interface	handle software interfaces.	GET	X-STRUCTURE-Id
/api/main/structure/offers	to receive current trade offers for the given software.	GET, PUT	X-STRUCTURE-Id
/api/main/search	search for profiles, programs or other publications on this platform.	GET	X-SEARCH-Query

Authentifizierung

Einige Endpunkte erfordern Berechtigungen und Zugriffstoken. Falls erforderlich, sollte die Session-ID im Header mitgegeben werden.

Fehlermanagement

Die API verwendet standardisierte HTTP-Statuscodes für Fehlerbehandlung:

200 OK - Anfrage erfolgreich
400 BAD REQUEST - Ungültige Parameter
401 UNAUTHORIZED - Keine Berechtigung
404 NOT FOUND - Endpunkt nicht gefunden
422 UNPROCESSABLE ENTITY - Erforderliche Header sind unvollständig
500 INTERNAL SERVER ERROR - Serverfehler

Beispielanfrage

Anfragen können über verschiedene HTTP-Methoden gesendet werden. Beispiel für eine GET-Anfrage:


    fetch('/api/profile', { method: 'GET', headers: { 'X-USER-Name': 'Beispiel' } }).then(response => response.json()).then(data => console.log(data));

Weitere Hinweise

Diese API ist primär für den internen Gebrauch vorgesehen. Änderungen an Endpunkten sollten dokumentiert werden, um die Funktionalität der Anwendung sicherzustellen.