BeeCollect API

Die BeeCollect API bietet die Möglichkeit, per Webservice Daten mit dem Sammlungs-Management MuseumPlus Classic der Firma zetcom auszutauschen. Softwareentwickler können über die API schnell und unkompliziert externe Datenbanken und Applikationen mit Daten aus MuseumPlus Classic versorgen oder auch Daten in MuseumPlus Classic einspielen und verändern.

Unabhängig davon, ob Sie die Erstellung einer eigenen Standortverwaltungs-App planen, externen Mitarbeitern den Zugriff auf Ihre Ausstellungsplanung ermöglichen wollen oder Sammlungsbestände für Portalsysteme zugreifbar machen wollen - mit der BeeCollect API liefern wir die Schnittstelle dafür.

Die API sorgt dabei nicht nur für eine sichere Authentifizierung der Clients und eine gesicherte, verschlüsselte Datenübertragung, sondern stellt auch zu jedem Zeitpunkt die Datenkonsistenz in MuseumPlus Classic sicher. Eine tiefere Kenntnis über den internen Aufbau und die Funktionsweise von MuseumPlus Classic ist für die Verwendung der API nicht notwendig.

Leistungsmerkmale

Bietet eine leistungsfähige Schnittstellen-Lösung entsprechend aktueller Standards

Die BeeCollect API stellt neben BeeCollect Sync einen zweiten, interessanten Weg dar, um Daten zwischen MuseumPlus Classic und anderen Applikationen auszutauschen. Während BeeCollect Sync aktiv Daten exportiert und importiert, agiert die BeeCollect API passiv und wartet permament auf externe Anfragen. Die Logik der Verarbeitung der aus MuseumPlus Classic exportierten Daten bzw. die Aufbereitung der Daten in das von der API erwartete Format liegt dabei in der Hand der externen Applikation.

Wichtige Funktionen und Eigenschaften der BeeCollect API sind:

  • Realisiert als RESTful Webservice
    Die BeeCollect API folgt damit dem aktuellen Standard für Schnittstellen dieser Art. Durch Einhaltung des REST-Standards sind zum einen auf der Serverseite keine Sessions notwendig, was für einen schonenden Umgang mit Speicherressourcen sorgt, zum anderen ist der Zugriff von Clientseite ausgesprochen einfach.
  • Hoher Standard bei Verschlüsselung und Authentifizierung
    Die BeeCollect API kommuniziert verschlüsselt über eine HTTPS-Verbindung. Damit sind alle zwischen Server und Client ausgetauschten Daten nach dem aktuellen Stand der Technik für Dritte unzugänglich. Für eine sichere Authentifizierung sorgen die HTTP-Authentication in Verbindung mit optionalen Client-Zertifikaten. Letztere sorgen dafür, dass nur bestimmte, vorher registrierte Clients eine Verbindung zum Server aufbauen können.
  • Einfacher Zugriff und hohe Abfrageleistung
    Bei der Entwicklung der API standen sowohl ein einfaches, logisches Zugriffskonzept und eine hohe Leistungsfähigkeit im Vordergrund. Noch nie konnten auf so einfache Weise Daten aus MuseumPlus abgerufen werden. Gleichzeitig werden auch umfangreiche Abfragen schnell und konsistent ausgeführt.

Funktionsumfang

Ermöglicht Lese- und Schreibzugriff auf die wichtigsten Module der Datenbank von MuseumPlus Classic

Die API stellt den lesenden und schreibenden Zugriff auf die Daten ausgewählter Module innerhalb der MuseumPlus-Datenbank zur Verfügung. Darüber hinaus können Informationen über das konfigurierte Datenbank-Metaschema (z.B. Feldattribute wie die aktuelle Beschriftung und verknüpftes Vokabular) abgerufen werden.

Folgende Module werden momentan von der API unterstützt:

  • Sammlung
  • Künstler/Beteiligte
  • Literatur
  • Ausstellung
  • Fotobestellung
  • Veranstaltung
  • Adressen

Für jedes Modul sind dabei sowohl die Grunddaten als auch (abhängig vom jeweiligen Modul) Zusatzdaten und Verknüpfungen abruf- und bearbeitbar. Abfrageergebnisse werden dabei wahlweise als JSON- oder XML-Struktur geliefert.

Für alle Module besteht die Möglichkeit, über Multimedia-Verknüpfungen eingebundene Dokumente und Bilder abzurufen. Diese werden als Base64-codierter Datenstrom an den Client übermittelt. Neue Multimedia-Verknüpfungen können durch Upload von Base64-codierten Dokumenten oder Bildern sowie zugehöriger Metadaten hergestellt werden.

Benutzerrechte

Differenzierte Festlegung der Zugriffsrechte

Für den Zugriff und die Verwendung der API ist ein BeeCollect-Benutzer erforderlich. Dieser kann über die BeeCollect Toolbox oder BeeCollect Professional in der MuseumPlus-Datenbank eingerichtet werden. Nur Benutzer, denen die BeeCollect API als Modul zugewiesen ist, können sich über die API mit der MuseumPlus-Datenbank verbinden. Darüber hinaus sind alle für den entsprechenden Benutzer eingestellten Zugriffsrechte in vollem Umfang wirksam. Der Benutzer kann also auch über die API nur auf die Daten zugreifen, für die entsprechende Zugriffsrechte erteilt worden sind.

Hinweis für die Festlegung der Benutzerrechte: Die BeeCollect API verwendet NICHT die MuseumPlus-Benutzer, daher kann auch über die Benutzerverwaltung von MuseumPlus Classic kein Zugriff auf die API eingerichtet oder entzogen werden. Sämtliche Zugriffsrechte werden ausschließlich entweder über die BeeCollect Toolbox oder BeeCollect Professional eingerichtet.

Technische Voraussetzungen

unkomplizierte techische Integration

Die BeeCollect API basiert auf dem Microsoft .NET Framework und kann auf jedem aktuellen Windows-Client- oder Serverbetriebssystem installiert werden. Für den Betrieb der API ist kein vorhandener Webserver wie IIS oder Apache notwendig, die API stellt einen eigenen Webserver zur Verfügung. Die Installation erfolgt wahlweise als Kommandozeilen-Applikation oder als Dienst.

Intern benötigt die BeeCollect API Zugriff auf den MS SQL Server, auf dem die MuseumPlus-Datenbank betrieben wird Der Zugriff erfolgt dabei über ADO .NET. Andere Datenbank-Backends wie Oracle oder MS Access werden momentan nicht unterstützt. Extern erfolgt die Kommunikation über einen frei konfigurierbaren Anschluss und TCP-Port. Die Verbindung mit den API-Clients wird wahlweise unverschlüsselt über HTTP bzw. SSL-verschlüsselt über HTTPS aufgebaut.

Die Authentifizierung der Clients ist über HTTP-Basic-Authentication und zusätzlich wahlweise über Client-Zertifikate möglich. Über die Client-Zertifizierung kann sichergestellt werden, dass unabhängig von einer Benutzeranmeldung nur bestimmte Kommunikationspartner eine Verbindung zur API aufbauen können.

Dokumentation

Antworten auf Ihre Fragen

Die vollständige Dokumentation der BeeCollect API inklusive Konfiguration des API-Servers und leicht nachvollziehbaren Abfragebeispielen finden Sie in unserer Wissensbasis.
mehr lesen

Highlights

Die wichtigsten Argumente für die BeeCollect API

  • maßgeschneiderte Programmier-Schnittstelle für MuseumPlus Classic
  • Daten per Webservice mit MuseumPlus Classic austauschen
  • keine Anpassungen Client-Software von MuseumPlus Classic  erforderlich
  • nahtlose Integration in die Client/ Server-Infrastruktur von MuseumPlus Classic

Nächste Schritte

Sie sind interessiert und möchten weitere Informationen?

Wir beraten Sie gerne:

Wir freuen uns auf Ihre Kontaktaufnahme!