OpenAPI-Spezifikation

Beta Die REST-API ist in der Beta. Endpunkte und Felder können sich bis zur Version 1.0.0 noch ändern.

GET/api/v1/openapi.json

GET /api/v1/openapi.json liefert die maschinenlesbare Beschreibung der REST-API im Format OpenAPI 3.0.3. Sie beschreibt die Endpunkte mit ihren Parametern, Antwortschemas und Fehlercodes und ist der verbindliche Vertrag der API. Für diesen Endpunkt brauchst du keinen API-Key.

Terminal

curl -s https://api.time.monkeymed.de/api/v1/openapi.json

Die Spezifikation kannst du in Werkzeuge laden, die OpenAPI unterstützen, zum Beispiel um Requests auszuprobieren oder einen API-Client für deine Programmiersprache zu erzeugen. Den benötigten Scope eines Endpunkts nennt die Spezifikation im Feld x-required-scope.

Datei herunterladen

Eine Kopie der Spezifikation für Version 1.0.0-beta.1 liegt unter https://docs.time.monkeymed.de/api/openapi.json zum Herunterladen bereit: openapi.json herunterladen.

Maßgeblich ist immer die Fassung unter https://api.time.monkeymed.de/api/v1/openapi.json. Die Version steht dort im Feld info.version. Solange die API in der Beta ist, kann sich die Spezifikation noch ändern; vergleiche bei Problemen deshalb mit der aktuellen Fassung.