Webinaris API

I) Einleitung

Über die Webinaris API ist es Ihnen möglich, Webinaris in Ihre eigene Software zu integrieren. Sie können dann durch Ihre eigene Software:

  • Teilnehmer für Webinare anlegen
  • Teilnehmer für Webinare sperren
  • Teilnehmer für Webinare freigeben

II) Funktion und Umsetzung

Die Webinars API funktioniert über einen HTTP GET Aufruf. In diesem HTTP GET Aufruf übergeben Sie Webinaris alle Daten, die benötigen werden, um einen Teilnehmer für ein Webinar anzumelden. 

1. HTTP Post

Der HTTP GET Aufruf ist wie folgt aufgebaut: 

https://webinaris.com/api/?key={key}&is_paid={is_paid}&time={date}&email={email}&firstname={firstname}&lastname={lastname}&ip_address={ip_address}&password={password}

Beispiel:

https://webinaris.com/api/?key=7167W1&is_paid=YES&time=31.01.2027%2016:50&email=max@mustermann.com&firstname=Max&lastname=Mustermann&ip_address=127.0.0.1&password=478ee73434a245e016f51d90ea301bcc

Für einen erfolgreich abgesetzten HTTP GET Aufruf wird der Wert "OK" zurückgegeben.

2. Pflichtangaben

Diese Parameter müssen zwingend eingefügt werden. Auch die Angabe eines Werts ist zwingend erforderlich.

key: Die Webinar-ID

Sie können die Webinar-ID in Ihrem Webinaris-Projekt unter "API" auslesen.

is_paid: Status des Zugangs

Werte: YES | NO

Hiermit geben Sie an, ob der Zugang des Teilnehmers für das Webinar freigegeben oder gesperrt ist. 

Beispiel: Verkaufen Sie kostenpflichtige Webinare, ist der Zugang nach der Bezahlung freigegeben. Storniert der Kunde seine Bestellung, können Sie den Zugang wieder sperren. 

time: Datum und Uhrzeit des Webinars

Format: "dd.mm.jjjj hh:mm" (ohne die "")
Beispiel: 31.01.2027 13:50

Webinaris legt den Webinartermin zur angegebenen Zeit in der deutschen Zeitzone UTC+1 an.

password: Der API-Key
Sie können den API-Key in Ihrem Projekt unter "API" auslesen.

3. Pflichtparameter

Diese Parameter müssen zwingend eingefügt werden. Die Angabe eines Werts ist optional.

email: Die E-Mail-Adresse des Teilnehmers

firstname: Der Vorname des Teilnehmers

lastname: Der Nachname des Teilnehmers

ip_address: Die IP-Adresse des Teilnehmers
Basierend auf der IP-Adresse wird die Zeitzone des Teilnehmers erkannt. Dadurch wird die ihm angezeigte Zeit in den Erinnerungs-E-Mails automatisch auf seine Zeitzone umgerechnet. 

4. Optionale Parameter

Diese Parameter können optional eingefügt werden. Auch die Angabe eines Werts ist optional.

timezone: Die Zeitzone, in der das Webinar angelegt werden soll

Format: utc | utc+1 | utc-1 | utc+1.5 | utc+1.75

note: Eine Notiz

phone: Die Telefonnummer des Teilnehmers

sender: Identifikation des Absenders

source_id: Die Source_ID

III) Zeitzonenlogik

Wird weder eine IP-Adresse noch eine Zeitzone übergeben, wird das Webinar in der UTC+1 (CET) Zeitzone angelegt.

Wird eine IP-Adresse, aber keine Zeitzone übergeben, wird die zu der IP gehörende Zeitzone analysiert und das Webinar in dieser Zeitzone angelegt.

Wird eine Zeitzone übergeben (egal, ob eine IP-Adresse übergeben wird oder nicht), wird das Webinar in der übergebenen Zeitzone angelegt. 

IV) Hinweis

Die API-Funktion befindet sich derzeit noch in einer BETA-Version. Das bedeutet, dass es nicht auszuschließen ist, dass vereinzelte Probleme auftreten. Es sind derzeit allerdings keine Probleme bekannt. Wenden Sie sich bitte an info@webinaris.com, wenn Sie Ihrerseits Probleme feststellen.

Haben Sie Fragen? Anfrage einreichen

Kommentare