BeeCollect API: Serverkonfiguration

Die Konfiguration des Webservers für die BeeCollect API erfolgt mit Hilfe einer XML-Datei

Die XML-Datei für die Konfiguration des API Servers kann in jedem geeigneten Editor bearbeitet werden. Alternativ steht in der BeeCollect Toolbox ein entsprechendes Modul für die benutzerfreundliche Bearbeitung zur Verfügung.

Lernen Sie hier den Aufbau der Konfigurationsdatei im Detail kennen:

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<beecollect>
  <api_server_configuration>
    <connection_settings>
    <server>PROXIMA\SQL2012</server>
    <database>mp_frankfurt_hmf_50</database>
    <username>sa</username>
    <password>JuA/31fxSWeLmIzxQnJbrqSKQxr5E2K2rvfSB1H6If8=</password>
    </connection_settings>
  <server_settings>
   <listen_address>0.0.0.0</listen_address>
    <listen_port>11077</listen_port>
    <certificate_file />
    <certificate_thumbprint>4E0EEBA01B56BAC6994BB7F5D5AD55D5C9C25190</certificate_thumbprint>
    <certificate_subject>localhost</certificate_subject>
    <check_certificate_revocation>false</check_certificate_revocation>
  </server_settings>
  <path_settings>
    <thumbnail_path_21></thumbnail_path_21>
    <thumbnail_path_25></thumbnail_path_25>
    <thumbnail_path_30></thumbnail_path_30>
    <thumbnail_path_40100></thumbnail_path_40100>
  </path_settings>
  <client_settings>
    <require_client_certificate>false</require_client_certificate>
    <allowed_clients />
    <read_only>false</read_only>
    <default_sync_app_name>false</default_sync_app_name>
    <default_sync_app_instance>false</default_sync_app_instance>
  </client_settings>
  </api_server_configuration>
</beecollect>
 

Folgende Konfigurationsoptionen stehen zur Verfügung:

Connection settings

  • server
    Bezeichnet den vollständigen Servernamen inkl. Instanznamen. Alternativ kann statt des Namens auch die IP-Adresse des Datenbankservers angegeben werden
  • database
    Bezeichnet die MuseumPlus-Datenbank, für welche die API ausgeführt werden soll
  • username
    Der SQL-Server-Benutzer mit ausreichenden Zugriffsrechten (mindestens db_read und db_write) für die angegebene Datenbank.
  • password
    Verschlüsseltes Passwort des SQL-Server-Benutzers. Das Password kann mit Hilfe der BeeCollect Toolbox verschlüsselt werden.

Server settings

  • listen_address
    Die Adresse bzw. die Netzwerkschnittstelle auf dem Server, an dem die API auf dem konfigurierten Port auf Anfragen lauschen soll. Die Angabe 0.0.0.0 steht für alle verfügbaren Netzwerkschnittstellen.
  • listen_port
    Der Port, auf dem die API auf Anfragen lauschen soll. Die API kann sich dabei einen Port NICHT mit einem anderen Webservice teilen.
  • certificate_file
    Das zu verwendende Zertifikat für die SSL-Verschlüsselung. Die Angabe ist nur erforderlich, wenn die Kommunikation mit der API verschlüsselt über HTTPS erfolgen soll.
  • certificate_thumbprint
    Der Fingerabdruck des zu verwendenden Serverzertifikats. Diese Angabe ist nur notwendig, wenn das Zertifikat nicht als Datei, sondern im Zertifikat-Speicher des Servers abgelegt wurde (als Computer-Zertifikat, nicht als Benutzerzertifikat). Die Angabe erfolgt als hexadezimaler Wert ohne Trennzeichen. Die Angabe wird ignoriert, wenn die Option certificate_file ausgefüllt ist.
  • certificate_subject
    Der Name, auf den das zu verwendende Zertifikat ausgestellt worden ist. Diese Angabe ist nur notwendig, wenn das Zertifikat nicht als Datei, sondern im Zertifikat-Speicher des Servers abgelegt wurde (als Computer-Zertifikat, nicht als Benutzerzertifikat). Die Angabe wird ignoriert, wenn die Option certificate_file ausgefüllt ist. Empfohlen wird bei Verwendung des Zertifikatspeichers die Angabe des Fingerabdrucks (siehe vorige Option), da diese ein Zertifikat zuverlässiger im Zertifikatspeicher identifizieren kann.
  • check_certificate_revocation
    Aktiviert die Online-Überprüfung der Gültigkeit der verwendeten Zertifikate.

Client settings

  • require_client_certificate
    Wenn aktiviert, können nur Clients, deren Zertifikat auf dem Server registriert wurde, eine Verbindung mit der API aufbauen.
  • allowed_clients
    Liste der zugelassenen Client-Zertifikate
  • read_only
    Der Zugriff wird unabhängig von den Rechten des jeweiligen Benutzers auf lesenden Zugriff beschränkt
  • default_sync_app_name
    Standard-Name der Sync-Applikation (wenn nicht im HTTP-Header übermittelt)
  • default_sync_app_instance
    Standard-Instanz der Sync-Applikation (wenn nicht im HTTP-Header übermittelt)

Path settings

  • thumbnail_path_21
    Pfad für Vorschaubild (Thumbnails) im Modul Sammlung.
  • thumbnail_path_25
    Pfad für Vorschaubild (Thumbnails) im Modul Bildarchiv.
  • thumbnail_path_30
    Pfad für Vorschaubild (Thumbnails) im Modul Künstler/Beteiligte (nicht von allen MuseumPlus-Versionen unterstützt).
  • thumbnail_path_40100
    Pfad für Vorschaubild (Thumbnails) im Modul Ausstellung (Ausstellungs-Bereiche).