API Nutzung_Allgemeine_Anleitung

Die SmartData API kann mit Tools wie Postman, JavaScript oder einfach über einen Browser genutzt werden.

Postman

Postman eignet sich, um Anfragen aufzubauen und auszutesten.

1. Öffnen Sie Postman
2. Legen Sie ein neues Request an (schauen Sie ggf. in der Postman-Anleitung nach)
3. Tragen Sie die Basis-URL in die Adressleiste ein. Die Basis-URL, ist die URL ihres Servers plus der Pfad zur deployten SmartData-Instanz z.B. http://localhost:8080/SmartData
4. Ergänzen Sie den Pfad zu der von Ihnen gewünschten Ressource (storage, collection oder records) z.B. 'http://localhost:8080/SmartData/smartdata/records/' (Zugriff auf Datensätze)
5. Ergänzen Sie den Pfad mit dem Funktionsnamen (bei Funktions-Resourcen), oder Datenobjektnamen (bei Daten-Resourcen) z.B. 'http://localhost:8080/SmartData/smartdata/records/MEINE_TABELLE' (Zugriff auf Daten in MEINE_TABELLE)
6. Fügen Sie ggf. Funktons-Parameter hinzu z.B. 'http://localhost:8080/SmartData/smartdata/records/MEINE_TABELLE?size=10' (Nur 10 Datensätze abrufen)

Welche Funktionen es gibt und welche Parameter diese haben, finden Sie in der Dokumentation im Abschnitt "Funktionen"

JavaScript

Sie können die API über JavaScript auf dieselbe Art wie in Postman nutzen. Verwenden Sie dort die fetch-API, um die Anfragen zu stellen.