Wenn du in deinem Webinaris-Account links ein dunkelgraues Menü hast, hast du die neue Version.
Klicke HIER, um zum Abschnitt für die alte Version zu springen.
Klicke HIER für weitere Informationen zu den Webinaris-Versionen.
I) Einleitung
Über die Webinaris API kannst du Webinaris in deine eigene Software zu integrieren. Du kannst dann durch deine Software:
- Teilnehmer für Webinare anlegen
- Teilnehmer für Webinare sperren
- Teilnehmer für Webinare freigeben
- Automatisch durch Webinaris generierte Termine abrufen
II) Funktion und Umsetzung: Teilnehmer anlegen, sperren oder freigeben
Die Webinars API funktioniert über einen HTTP GET Aufruf. In diesem HTTP GET Aufruf übergibst du Webinaris alle Daten, die benötigen werden, um einen Teilnehmer für ein Webinar anzumelden.
1. HTTP GET Aufruf
Der HTTP GET Aufruf ist wie folgt aufgebaut:
https://webinaris.co/api/?key={key}&is_paid={is_paid}&time={date}&email={email}&firstname={firstname}&lastname={lastname}&ip_address={ip_address}&password={password}
Beispiel:
https://webinaris.co/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
Du kannst die Webinar-ID im jeweiligen Webinar unter "Experten-Einstellungen -> API" auslesen.
is_paid: Status des Zugangs
Werte: YES | NO
Hiermit gibst du an, ob der Zugang des Teilnehmers für das Webinar freigegeben oder gesperrt ist.
Beispiel: Verkaufst du kostenpflichtige Webinare, ist der Zugang nach der Bezahlung freigegeben. Storniert der Kunde seine Bestellung, kannst du 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 an.
password: Der API-Key
Du kannst den API-Key in deinem Webinar unter "Experten-Einstellungen -> API" auslesen.
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. Sollte keine IP abgefragt werden, verwende bitte einfach die 127.0.0.1
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
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
utm_campaign: Der UTM_Campaign Paramter
utm_content: Der UTM_Content Paramter
utm_medium: Der UTM_Medium Paramter
utm_source: Der UTM_Source Paramter
utm_term: Der UTM_Term Paramter
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) Webinar-Termine auslesen
Über einen GET-Call kannst du auch die Webinar-Termine eines Webinars auslesen. So kannst du für die Anbindung die intelligente Webinaris-Terminlogik verwenden.
1. Der GET-Call
Der GET-Call sieht wie folgt aus:
https://webinaris.co/api/showtimes?webinaris_id={Webinar-ID}&api_password={API-Passwort}
Beispiel:
https://webinaris.co/api/showtimes?webinaris_id=11751W4V&api_password=d9100d77bb3e69fb159b25eaddcb669f
Als Antwort erhältst du dann folgende Werte:
SHOWTIME | Der Webinar-Termin |
VMAX | Die maximal verfügbaren Plätze |
VFREE | Die noch freien Plätze |
UNIX | Der Webinar-Termin im Unix Timestamp-Format |
TZONE | Die Zeitzone des Webinar-Termins |
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. Wende dich bitte an info@webinaris.com, solltest du Probleme feststellen.
Wenn du in deinem Webinaris-Account oben eine blaue Leiste hast, hast du die alte Version.
Klicke HIER, um zum Abschnitt für die alte Version zu springen.
Klicke HIER für weitere Informationen zu den Webinaris-Versionen.
I) Einleitung
Über die Webinaris API ist es dir möglich, Webinaris in deine eigene Software zu integrieren. Du kannst dann durch deine eigene Software:
- Teilnehmer für Webinare anlegen
- Teilnehmer für Webinare sperren
- Teilnehmer für Webinare freigeben
II) Funktion und Umsetzung: Teilnehmer anlegen, sperren oder freigeben
Die Webinars API funktioniert über einen HTTP GET Aufruf. In diesem HTTP GET Aufruf übergibst du Webinaris alle Daten, die benötigen werden, um einen Teilnehmer für ein Webinar anzumelden.
1. HTTP GET Aufruf
Der HTTP GET Aufruf ist wie folgt aufgebaut:
https://webinaris.co/api/?key={key}&is_paid={is_paid}&time={date}&email={email}&firstname={firstname}&lastname={lastname}&ip_address={ip_address}&password={password}
Beispiel:
https://webinaris.co/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
Du kannst die Webinar-ID in deinem Webinaris-Projekt unter "API" auslesen.
is_paid: Status des Zugangs
Werte: YES | NO
Hiermit gibst du an, ob der Zugang des Teilnehmers für das Webinar freigegeben oder gesperrt ist.
Beispiel: Verkaufst du kostenpflichtige Webinare, ist der Zugang nach der Bezahlung freigegeben. Storniert der Kunde seine Bestellung, kannst du 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
Du kannst den API-Key in deinem Projekt unter "API" auslesen.
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. Sollte keine IP abgefragt werden, verwende bitte einfach die 127.0.0.1
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
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
utm_campaign: Der UTM_Campaign Paramter
utm_content: Der UTM_Content Paramter
utm_medium: Der UTM_Medium Paramter
utm_source: Der UTM_Source Paramter
utm_term: Der UTM_Term Paramter
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) Webinar-Termine auslesen
Über einen POST-Call kannst du auch die Webinar-Termine eines Webinars auslesen. So kannst du für die Anbindung die intelligente Webinaris-Terminlogik verwenden.
1. Der GET-Call
Der GET-Call sieht wie folgt aus:
https://webinaris.co/api/showtimes?webinaris_id={Webinar-ID}&api_password={API-Passwort}
Beispiel:
https://webinaris.co/api/showtimes?webinaris_id=11751W4V&api_password=d9100d77bb3e69fb159b25eaddcb669f
Als Antwort erhältst du dann folgende Werte:
SHOWTIME | Der Webinar-Termin |
VMAX | Die maximal verfügbaren Plätze |
VFREE | Die noch freien Plätze |
UNIX | Der Webinar-Termin im Unix Timestamp-Format |
TZONE | Die Zeitzone des Webinar-Termins |
Die Anzahl der zurückgegebenen Termine hängt von der Anzahl der Termine ab, die gemäß der Einstellung im Menü "Termine" im Anmeldeformular angezeigt werden sollen.
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. Wende dich bitte an info@webinaris.com, solltest du Probleme feststellen.