Metainformationen zur Seite
  •  

Dies ist eine alte Version des Dokuments!


BeeCollect Cloud: Wie es funktioniert

Startseite

Die BeeCollect Cloud API

Die BeeCollect Cloud API ermöglicht das sichere Hoch- und Herunterladen von Daten und Medien in die BeeCollect Cloud über ein modernes Authentifizierungs- und Freigabeverfahren. Daten und Medien können dabei nur von entsprechend berechtigten Akteuren eingesehen oder verändert werden.

Neben der BeeCollect Cloud API sind in der BeeCollect Cloud auch noch weitere Schnittstellen wie OAI-PMH oder IIIF integriert - auf diese wird an anderer Stelle noch näher eingegangen.

Authentifizierung und Rechtevergabe

In der BeeCollect Cloud sind alle Daten und Medien einer Organisation zu einem gemeinsamen Core zusammengefasst. Damit eine Person oder eine Software auf diesen Core zugreifen kann, wird ein ShareKey benötigt.

Jede Organisation besitzt genau einen primären ShareKey, welcher den gesamten Core repräsentiert und „der Organisation gehört“, die die Daten bereitstellt. Zusätzlich können weitere ShareKeys erzeugt werden. Solche zusätzlichen ShareKeys werden gezielt bestimmten eigenen Daten(sätzen) zugeordnet und an externe Akteure weitergegeben – zum Beispiel Partnerinstitutionen oder Projekte. Ein ShareKey ist dabei nicht nur ein Zugangsschlüssel, sondern enthält gleichzeitig die Berechtigungen, also welche Daten gesehen oder genutzt werden dürfen und in welchem Umfang.

Um überhaupt mit der Cloud arbeiten zu können (also z. B. Daten abzufragen oder zu importieren), wird außerdem ein AccessToken benötigt. Dieses Token wird über den Organisations-Schlüssel zusammen mit einem Secret - also einem Geheimwort - angefordert. Das AccessToken ist jeweils 10 Minuten gültig und dient als kurzfristiger, sicherer Arbeitsnachweis für die laufende Verbindung.

Man könnte diese Mechanik auch kurz beschreiben mit:

  • AccessToken = „Wer bist du?“
  • ShareKey = „Welche Daten darfst du mit welchen Rechten nutzen?“

Daten und Medien hochladen und teilen

Für Organisationen, die BeeCollect Professional nutzen, ist der Zugang zur BeeCollect Cloud recht einfach. Das Programm BeeCollect Professional enthält in den relevanten Programmmodulen bereits alle notwendigen Funktionen, um Daten und Medien für die Bereitstellung in der BeeCollect Cloud zu markieren und festzulegen, mit wem sie geteilt werden sollen. Die eigentliche Bereitstellung übernehmen dann BeeCollect Sync bzw. der BeeCollect Server. Hier werden die ausgewählten Daten in das für die BeeCollect Cloud vorgesehene Format (z.B. BC_JSON,LIDO,EDM oder DC) transformiert und dann in die BeeCollect Cloud hochgeladen.

Akteure ohne BeeCollect Professional können ebenfalls Daten in der BeeCollect Cloud bereitstellen, wenn sie dazu berechtigt sind. Die BeeCollect Cloud API ist entsprechend dokumentiert, so dass es mit wenig Aufwand möglich ist, eine eigene Schnittstelle zur BeeCollect Cloud zu implementieren. Wir stellen dafür ein Swagger-YAML bereit, welches alle dafür notwendigen Deklarationen und Parameter enthält.

Daten und Medien herunterladen