Willkommen zur Dokumentation für die Verowa-API.
Die Verowa-API ist über eine REST-Schnittstelle zu erreichen und bietet eine grosse Anzahl Funktionen, um Webdienste mit Verowa-Daten zu Veranstaltungen, Personen und vielem mehr zu versorgen. Grundsätzlich können Sie in jeder Anwendung Verowa-Daten abgreifen, die Ihnen erlaubt, eine Anfrage an eine URL zu schicken und die Antwort im JSON-Dateifromat entgegenzunehmen.
Instanzname und API Key
Für die Verwendung der Verowa-API benötigen Sie einen Key, den Sie beim Verowa-Support beantragen können. Er besteht aus 32 Buchstaben und Ziffern, z.B. «8209042b1786e26c355d4aea1b8c7b79». Ausserdem benötigen Sie den Instanznamen, z.B. «meine-gemeinde». Typischerweise entspricht er der Second-Level-Domain der Webseite der Kirchgemeinde bzw. Pfarrei.
Für WordPress gibts ein eigenes Plugin
Falls Sie mit WordPress arbeiten, nutzen Sie mit Vorteil unser umfangreiches, fixfertiges und kostenloses Plugin Verowa-Connect.
Evtl. reicht schon ein iCal-Feed?
Falls Sie nur spärliche Informationen benötigen, z.B. für einen Belegungsplan, verwenden Sie evtl. der Einfachheit halber besser eine ICS-Datei. URLs für individuelle Kalender-Abo-Feeds können Sie direkt in Verowa erstellen.
🚀 Schnellstart
Mit einem einzigen Aufruf können Sie die wichtigsten Veranstaltungsinformationen abrufen. Sie reichen, um eine lokale Datenbank zu versorgen und daraus eine übersichtliche Agenda und zu jeder Veranstaltung eine Detailseite inkl. Bild und diverser Angaben zu erstellen. > mehr
Live-Updates
Um die Serverlast auf beiden Seiten gering zu halten und die Integration der API trotzdem mit sehr wenig Aufwand zu ermöglichen, haben wir uns ein einfaches, aber zuverlässiges Prinzip überlegt, damit Ihr Webdienst über Aktualisierungen auf dem Laufenden bleibt. Es ist nicht nötig, alle paar Minuten den kompletten Bestand abzufagen! > mehr
Grundprinzip
Eine REST-Anfrage an die Verowa-API ist mit einer einzigen GET-Anfrage möglich:https://api.verowa.ch/[Funktion gemäss Referenz]/instance/apikey/[zusätzliche Parameter]
Beispiel (liefert alle aktuellen Veranstaltungen mit Detailangaben):https://api.verowa.ch/geteventdetails/demo/8209042b1786e26c355d4aea1b8c7b79/0
Demo-Daten für die REST-Schnittstelle: :instance =demo:apikey =8209042b1786e26c355d4aea1b8c7b79