API

Die API ermöglicht die Integration unserer Dienste in Ihre Anwendung und ist unter https://igsn.uni-kiel.de/api/ verfügbar.

Zugangstypen

Jeder Benutzer hat einen API-Zugangstyp.

Zugangstyp	Beschreibung
Keine	Der Benutzer kann nicht auf die API zugreifen.
Standard	Dies ist die Standard-API-Zugriffsart. Der Benutzer kann auf die Standard-API-Routen zugreifen.
Erweitert	Der Benutzer kann auf die Standard- und erweiterten API-Routen zugreifen.

API-Schlüssel

Wenn Sie die API nutzen möchten, müssen Sie zunächst einen API-Schlüssel erstellen. So können Sie das tun:

Klicken Sie auf Ihren Benutzernamen.
Wählen Sie Mein Profil aus der Dropdown-Liste.
Suchen Sie in Ihren Profileinstellungen nach der Option, API-Schlüssel zu erstellen.
Klicken Sie auf die Schaltfläche API-Schlüssel erstellen, um Ihren API-Schlüssel zu generieren.

Formular zum Erstellen von API-Schlüsseln

Routen

Standard

Bemerkung

Um auf die Standardrouten zugreifen zu können, muss der Benutzer Standard oder erweiterten API-Zugang haben.

Anträge auf Registrierung

Typ	Route	Beschreibung
GET	/api/registration_requests	Ruft die Sammlung von RegistrationRequest-Ressourcen ab.
POST	/api/registration_requests	Erzeugt eine RegistrationRequest-Ressource.
GET	/api/registration_requests/{id}	Ruft eine RegistrationRequest-Ressource ab.
PUT	/api/registration_requests/{id}	Ersetzt die Ressource RegistrationRequest.

Bemerkung

Bitte beachten Sie, dass Sie nur auf Ihre eigenen Registrierungsanfragen zugreifen können.

Repositories

Typ	Route	Beschreibung
GET	/api/repositories	Ruft die Sammlung von Repository-Ressourcen ab.
GET	/api/repositories/{prefix}	Ruft eine Repository-Ressource ab.

DOI

Typ	Route	Beschreibung
GET	/api/dois	Gibt eine Liste von DOIs zurück.
GET	/api/dois/{id}	Ruft eine DOI-Ressource ab.

Bemerkung

Bitte beachten Sie, dass diese Routen auf die DataCite-API gespiegelt werden und Sie nur auf DOIs zugreifen können, die in Repositorien gespeichert sind, auf die Sie Lesezugriff haben.

Erweitert

Bemerkung

Um auf die erweiterten Routen zugreifen zu können, muss der Benutzer erweiterten API-Zugang haben.

Bitte beachten Sie, dass diese Routen auf die DataCite-API gespiegelt werden und Sie nur DOIs erstellen oder aktualisieren können, die in Repositories gespeichert sind, auf die Sie Schreibrechte haben.

Beispiele

Abrufen der Sammlung Ihrer Registrierungsanfragen

curl -X 'GET' \
  'https://igsn.uni-kiel.de/api/registration_requests' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <your-api-key>'

Abrufen einer Sammlung aller Repositories

curl -X 'GET' \
  'https://igsn.uni-kiel.de/api/repositories' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <your-api-key>'

Abrufen eines Repositorys nach Präfix

curl -X 'GET' \
  'https://igsn.uni-kiel.de/api/repositories/<prefix>' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <your-api-key>'

Erstellen Sie eine Registrierungsanfrage

curl -X 'POST' \
  'https://igsn.uni-kiel.de/api/registration_requests' \
  -H 'accept: application/ld+json' \
  -H 'Content-Type: application/ld+json' \
  -H 'Authorization: Bearer <your-api-key>' \
  -d '{
    "title": "My title",
    "notes": "some notes",
    "repository": "/api/repositories/<prefix>",
    "data": [
      <your-registration-data>
    ]
  }'