0.0
No commit activity in last 3 years
No release in over 3 years
A simple ruby API wrapper for retrieving webinar data
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.10
~> 10.0
>= 0

Runtime

 Project Readme

WebinarjamApi

A simple ruby API wrapper for retrieving webinar data from WebinarJam. Currently WebinarJam's API only supports retrieval of webinars, no registrants. However you can add registrants to a webinar.

Installation

Add this line to your application's Gemfile:

gem 'webinarjam_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install webinarjam_api

Usage

Configuration

Create a client object:

client = ::WebinarjamApi::Client.new('Your API Key')

Note: Pass in the API Key as a string, wrap it in quotes.

Retrieve all your webinars:

client.get_webinars

Pass in the 'webinar_id' to retrieve the specific webinar:

client.get_webinar(webinar_id)

Add registrants to the webinar

Create a registrant, required fields are name and email.

registrant = {
  'name' => 'Chico Manzana',
  'email' => 'chico@manzana.com'
}

Pass in registrant, along with webinar_id and schedule into the register_person method.

client.register_person(webinar_id, schedule, registrant)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jzntam/webinarjam_api.

License

The gem is available as open source under the terms of the MIT License.