Übersicht

Dieses Dokument beschreibt die offizielle REST-API des URN-Service in der Version v2.

Basis-Adresse und Versionierung

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. Im Normalfall wird nur eine Version der API angeboten. Nur beim Erscheinen einer neuen Version werden temporär zwei Versionen angeboten.

Sandbox

Der URN-Service bietet neben der produktiven API auch eine Sandbox-API an. Diese kann für Entwicklung und Tests von Anwendungen genutzt werden, um URNs und URLs zu Testzwecken registrieren und verwalten zu können, ohne den produktiven URN-Datenbestand zu beeinflussen.

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:

Benutzer und Namensräume, die im Produktivsystem angelegt wurden, sind nicht automatisch in der Sandbox verfügbar. Bitte kontaktieren Sie den URN-Support, um die für Ihre Tests benötigten Benutzer und Namensräume einrichten zu lassen.

Datenformat

Alle Daten werden im JSON-Format mit UTF-8-Kodierung übertragen. Als Media-Typ wird application/json erwartet und zurückgeliefert. Bei PATCH-Anfragen kann alternativ auch der spezifischere Media-Typ application/merge-patch+json angegeben werden.

In den Antworten des URN-Service werden leere Felder nicht weggelassen, sondern als null ausgeliefert. Bei POST-Anfragen, die an den URN-Service geschickt werden, können optionale Felder sowohl auf null gesetzt werden oder weggelassen werden. Die JSON-Dokumente, die als PATCH-Anfragen an den URN-Service geschickt werden, werden als JSON Merge-Patch (RFC 7386) interpretiert. D.h. bei übermittelten Feldern wird der Feldinhalt übernommen, nicht übermittelte Felder werden nicht geändert und auf null gesetzte Felde werden gelöscht bzw. zurückgesetzt.

Zeitangaben erfolgen im ISO 8601 Format: YYYY-MM-DDTHH:MM:SS±hhmm.

Authentifizierung

Anfragen auf Ressourcen, die Änderungen im URN-Service durchführen, bedürfen einer Authentizierung. Darüberhinaus unterscheiden sich einige Antworten des URN-Service in ihrem Umfang abhängig davon, ob sie mit oder ohne Authentizifierung durchgeführt werden. Beim Versuch, ohne Authentizierung auf eine Ressource zuzugreifen, die nur nach Authentifizierung zugänglich ist, wird entweder ein HTTP-Status 403 Forbidden oder 404 Not Found zurückgeliefert, abhängig davon, ob die Existenz der Ressource bekannt sein darf oder nicht. Beim Zugriff auf Ressourcen, die nicht zwingend eine Authentizierung benötigen, werden fehlerhaften Zugangsdaten ignoriert.

Als Authentizierungsverfahren wird HTTP Basic Authentication verwendet.

Referenz

Eine detaillierte Übersicht über alle Befehle der REST-API wird als Teil der REST-API unter docs/index.html angeboten.

Los gehts: Beispiele

Mit einem GET-Request auf die Basis-Adresse können Sie eine Liste aller Endpunkte in der API abrufen:

curl https://api.nbn-resolving.org/v2/