Diese API ermöglicht den Zugriff auf verschiedene Ressourcen. Sie dient u.a. der Verwaltung von Daten und Interaktionen zwischen Frontend und Backend.
| Ressource | Beschreibung | Methoden | Erforderliche Header |
|---|---|---|---|
| /api/main/platform/preview | deal with platform preview files such as video, audio or image files. | GET, PUT | / |
| /api/main/profile | request public user-profile information. | GET | X-USER-Name |
| /api/main/structure/files | deal with program preview files such as video, audio or image files. | GET, PUT | X-STRUCTURE-Id |
| /api/main/structure/icon | request an program icon. | GET | X-STRUCTURE-Id |
| /api/main/structure/content | request an program based on structure id. | GET | X-STRUCTURE-Id, X-STRUCTURE-Version |
| /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 | X-STRUCTURE-Id |
| /api/main/search | search for profiles, programs or other publications on this platform. | GET | X-SEARCH-Query |
Einige Endpunkte erfordern Berechtigungen und Zugriffstoken. Falls erforderlich, sollte die **Session-ID** im Header mitgegeben werden.
Die API verwendet standardisierte HTTP-Statuscodes für Fehlerbehandlung:
Anfragen können über verschiedene HTTP-Methoden gesendet werden. Beispiel für eine GET-Anfrage:
libraya.net
fetch('/api/profile', { method: 'GET', headers: { 'X-USER-Name': 'Beispiel' } }).then(response => response.json()).then(data => console.log(data)); Diese API ist primär für den internen Gebrauch vorgesehen. Änderungen an Endpunkten sollten dokumentiert werden, um die Funktionalität der Anwendung sicherzustellen.
