azizi:import

API für Datenbezüger

Die Azizi-Plattform liefert die Basis zum Austausch von Event-Daten im Minasa-Schema. Interessierte Bezüger können über eine API die gewünschten Daten abrufen.

Zum Download der Daten wird ein API-Key benötigt, der bei Saiten bestellt werden kann.

Die Authorisierung erfolgt mit API-Key im HTTP-Header nach folgendem Schema:

HTTP Headerauth-schemeauthorization-parameters
AuthorizationapikeyAPI-KEY

Beispiel:

     curl \
      --location 'https://azizi.nilkream.ch/export/events/v/1' \
      --header 'Authorization: apikey XYZ01234...ABC'

Daten werden im XML-Format ausgeliefert. Elemente, die HTML-Formatierung enthalten können sind als CDATA-Abschnitt ausgewiesen.

Bilder werden als Download-URL verlinkt und sind vom empfangenden System separat herunterzuladen.

Azizi stellt verschiedene Filter zur Verfügung, die als HTTP-Query-Parameter übergeben werden:

ParameterBeschreibungBeispieleErläuterungen
category Veranstaltungs-Kategorie, Rubrikcategory=Literatur,Kunst gültige Kategorie gemäss Azizi-Schema
zip PLZ des Veranstaltungsortszip=9000,9001,9004,9006,9007,9008,9009,9010,9011,9012,9013,9014,9015,9016 Bsp. für gesamte Stadt St. Gallen
canton Kanton des Veranstaltungsortscanton=AI,AR Bsp. für beide Appenzell
dataProviderIncluded nur diese Azizi-DatenlieferantendataProviderIncluded=0187dc91-efa5-7e6f-a417-5a9bb49bb64e GUIDs von Datenlieferanten werden von Azizi fix vergeben
dataProviderExcluded ausser diese Azizi-DatenlieferantendataProviderExcluded=0187dc91-efa5-7e6f-a417-5a9bb49bb64e GUIDs von Datenlieferanten werden von Azizi fix vergeben

Werden mit der Anfrage keine Filter mitgeschickt, liefert Azizi alle aktuellen, verfügbaren Event-Daten aus.

Verschiedene Filter können in derselben Abfrage kombiniert werden.

Beispiel:

     curl \
      --location 'https://azizi.nilkream.ch/export/events/v/1?canton=AI,AR&category=Literatur,Kunst' \
      --header 'Authorization: apikey XYZ01234...ABC'

Azizi importiert in der Regel einmal pro Tag Event-Daten aus direkt-angebundenen externen Datenbanken (i.d.R. Websites von Veranstaltern) und aus den verbundenen Minasa-Systemen.

Die Event-Daten sind einmal täglich abzurufen und für die Weiterverabeitung auf einem Server beim Datenbezüger zu speichern. Downloads werden überwacht und blockiert, falls pro Zeiteinheit mehr als eine definierte Anzahl von Zugriffen mit demselben API-Key erfolgt.

  • azizi/import.txt
  • Zuletzt geändert: 07.03.2024 16:42
  • von manuel.maerklin