Webinaris API

I) Introduction

The Webinaris API allows you to integrate Webinaris into your own software. You can then user your own software to:

  • Create participants for webinars
  • De-activate participants for webinars
  • Activate participants for webinars

II) Function and implementation: Create, activate or deactivate participants

The Webinars API works via an HTTP GET call. In this HTTP GET call you give Webinaris all the data that will be needed to register a participant for a webinar. 

1. HTTP GET call

The HTTP GET call is structured as follows: 

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

Example:

https://webinaris.co/api/?key=7167W1&is_paid=YES&time=31.01.2027%2016:50&email=john@doe.com&firstname=John&lastname=Doe&ip_address=127.0.0.1&password=478ee73434a245e016f51d90ea301bcc

The value "OK" is returned for a successful HTTP GET call.

2. mandatory information

These parameters must be inserted. You must also specify a value.

key: The Webinar-ID

Please find the Webinar ID in your webinar project in menu "Communiation" -> "API"

is_paid: Status of the access

Values: YES | NO

Specifies whether the participant's access to the webinar is activated or de-activated. 

Example: If you sell paid webinars, access is granted after payment. If the customer cancels his order, you can de-activate the access again. 

time: date and time of the webinar

Format: "dd.mm.jjjj hh:mm" (without "")
Example: 31.01.2027 13:50

Webinaris creates the webinar start date at the given time in the German time zone.

password: The API-Key
Please find the API-Key in your webinar project in menu "Communiation" -> "API"

ip_address: The IP address of the participant
Based on the IP address, the time zone of the subscriber is recognized. This automatically converts the time displayed in the reminder emails to his time zone. If no IP should be queried, please simply use the 127.0.0.1

3. mandatory parameter

These parameters must be inserted. Specifying a value is optional.

email: The e-mail address of the participant.

firstname: The first name of the participant.

lastname: The last name of the participant.

4. Optional parameters

These parameters can be inserted optionally. Specifying a value is also optional.

timezone: The time zone in which the webinar is to be created.

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

note: A note

phone: The telephone number of the participant.

sender: Identification of the sender

source_id: The Source_ID

III) Time zone logic

If neither an IP address nor a time zone is transferred, the webinar is created in the UTC+1 (CET) time zone.

If an IP address but no time zone is transferred, the time zone belonging to the IP is analyzed and the webinar is created in this time zone.

If a time zone is transferred (regardless of whether an IP address is transferred or not), the webinar is created in the transferred time zone. 

IV) Read out webinar showtimes

You can also use a POST call to read the webinar dates of a webinar. So you can use the intelligent Webinaris scheduling logic for the connection.

1. The POST-Call

The POST call looks like this:

https://webinaris.co/api/showtimes?webinaris_id={Webinar-ID}&api_password={API-Passwort}

Example

https://webinaris.co/api/showtimes?webinaris_id=11751W4V&api_password=d9100d77bb3e69fb159b25eaddcb669f 

You will then receive the following values in response:

SHOWTIME The webinar showtime
VMAX Maximum number of seats available
VFREE The seats still available
UNIX The Webinar Date in Unix Timestamp Format
TZONE The time zone of the webinar showtime

If "Autodetect" is selected for the webinar showtimes, the German time zone is always used automatically. 

The number of appointments returned depends on the number of showtimes to be displayed in the registration form according to the setting in the "Showtimes" menu. 

IV) Note

The API function is currently still in a BETA version. This means that it cannot be ruled out that isolated problems may occur. However, there are currently no known problems. Please contact info@webinaris.com if you experience any problems.

Have more questions? Submit a request

Comments