...
Die URN-Service API ist unter der Basis-Adresse https://api.nbn-resolving.org/ zu erreichen.
Die API ist versioniert, um bei inkompatiblen Veränderungen zeitweise mehrere Versionen der API betreiben zu können. Die Versionierung erfolgt über das Anhängen der API-Version an die Basis-Adresse. Die derzeit aktuelle Version ist v2:
...
Die Sandbox-API des URN-Service ist unter der Basis-Adresse https://api.nbn-resolving.org/sandbox/ zu erreichen. Die Versionierung erfolgt wie oben beschrieben. Die vollständige Basis-Adresse der Sandbox-API inklusive Versionsnummer lautet:
...
Die URN-Service API strebt eine korrekte Nutzung der HTTP-Verben an.
| HTTP-Verb | Beschreibung |
|---|---|
HEAD | Wird benutzt, um nur die HTTP-Header für eine Ressource abzufragen |
GET | Wird für das Abfragen von Ressourcen genutzt |
POST | Wird benutzt, um neue Ressourcen anzulegen |
PATCH | Wird verwendet, um Ressourcen mit partiellen JSON-Objekten zu aktualisieren |
PUT | Wird aktuell nicht von der REST-API verwendet |
DELETE | Wird benutzt, um Ressourcen zu löschen |
Fehler
Wenn eine Anfrage an die URN-Service API fehlschlägt, enthält die Antwort ein JSON-Objekt mit einer genaueren Fehlermeldung:
...