Open-VHS-Schnittstelle bzw. Schnittstelle zur vhsApp

Einrichtung der Schnittstelle
Zuerst erstellen Sie bitte unter „Schnittstellen“ (erreichbar über die Objekte auf der „Startseite“) die Schnittstelle in dem Sie auf "Schnittstelle erstellen" klicken und die Vorlage "Open-VHS" auswählen.

Damit Sie die Schnittstelle nutzen können, tragen Sie in der Detailseite der Schnittstelle den Token, (eine Zahlen-/Buchstabenkombination) ein, den Sie vom Deutschen Volkshochschulverband (dvv) erhalten haben, zunächst in der Schnittstelle bei Benutzername und Passwort ein.

Fügen Sie sich dann die Applikation "Einstellung" hinzu. Gehen Sie in die Applikation "Einstellungen" und klicken Sie auf die Vorlage „Schnittstelle >> Token“.Anschließend klicken Sie in die Einstellung und tragen Sie in der Eigenschaft "Wert" den Token erneut ein.

Für den automatisierter Export gehen Sie zurück in die Detailansicht der Schnittstelle. Hinterlegen Sie hier in der Eigenschaft „Webadresse“ die URL „https://api.volkshochschule.de/1/upload“. Bei der Eigenschaft „Report“ hinterlegen Sie einen Report (z.B.: „Open-VHS Export“), der die automatisch zuexportierenden Kurse beinhaltet. Bei "Intervall" wählen Sie aus der Dropdown (stündlich/täglich/wöchentlich) das für Sie passende Übertragungsintervall aus.

Die generierten Exportdokumente werden Ihnen im unteren Bereich der Schnittstelle angezeigt.

Export von Veranstaltungen
Nun können Sie über einen Ihrer Veranstaltungsreports die gewünschten Kurse zur Übertragung auswählen. Über „Optionen“ -> „Export“ -> „als Daten“ -> „Schnittstellen“ -> „Open-VHS“ können die Veranstaltungsdaten anschließend exportiert werden.

Nach dem Export werden Sie auf die Schnittstellen-Detailseite weitergeleitet. Das Dokument, das Sie anschließend zur vhsApp übertragen können, steht dort unter der Applikation „Dokumente“ zur Verfügung.
Wenn Sie diese Applikation nicht sehen, wählen Sie bitte unterhalb der Applikationsliste „Applikation hinzufügen“ und „Dokumente“.

Laden Sie dann die Exportdatei über den Link „herunterladen“ auf Ihren lokalen Rechner herunter. Anschließend öffnen Sie den Link https://api.volkshochschule.de/1/upload/test, um die Exportdatei zu Open-VHS-Schnittstelle hochzuladen.