Verfügbare APIs

Siehe diese Seite für eine Übersicht der verfügbaren APIs.

Dokumentation
Wie kann ich Ihre APIs verwenden?

Der Webservice nutzt die Technik REST. Dabei werden verschiedene Formate unterstützt, wobei das JSON-Format das Standard- und empfohlene Format ist.

Dokumentation
Kann ich die API mithilfe eines Explorers ansehen?

Der API-Explorer ist über https://<UWDOMEIN>/api/rest/explorer/ erreichbar.

Dokumentation
Ist ein Swagger-Import verfügbar?

Eine Swagger-Datei enthält alle Definitionen der API und kann beispielsweise in Postman verwendet werden.

Dokumentation
Wie funktioniert die Sicherheit der API?

Für den Webservice gelten verschiedene Sicherheitsniveaus. Es gibt öffentliche Datensammlungen und Methoden sowie gesicherte Sammlungen und Methoden. Dies wird...

Dokumentation
Wie funktioniert ein API-Schlüssel?

Für den Webservice gelten verschiedene Sicherheitsstufen. Für anonyme Calls, wie das Abrufen der Merkmale eines Objekts, ist anonymer Zugriff möglich.

Dokumentation
Welche Formate werden unterstützt?

Nicht nur das Standardformat JSON, sondern auch andere Formate wie XML werden unterstützt.

Dokumentation
Wie funktioniert die Expansions-Technik?

Für den Webservice wird eine spezielle Technik verwendet, um so effizient wie möglich mit den Daten umzugehen. Die Technik wird Expansion genannt.

Dokumentation
Wie funktioniert die Fehlerbehandlung?

Der Webservice ist auf die Verarbeitung von Daten ausgelegt. Dabei können Fehler auftreten. Die Kommunikation über diese Fehler erfolgt auf strukturierte Weise,...

Dokumentation
Authentifizieren über Oauth 2.0

Die Schritte zum Einrichten eines authentifizierten Benutzers:

Anleitung