https://github.com/eventbrite/eventbrite.jquery.js
A javascript-based Eventbrite API client library. (requires jQuery)
https://github.com/eventbrite/eventbrite.jquery.js
Last synced: 3 months ago
JSON representation
A javascript-based Eventbrite API client library. (requires jQuery)
- Host: GitHub
- URL: https://github.com/eventbrite/eventbrite.jquery.js
- Owner: eventbrite
- Created: 2013-09-04T21:11:28.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-05-17T19:05:58.000Z (about 2 years ago)
- Last Synced: 2023-05-17T19:27:50.538Z (about 2 years ago)
- Language: JavaScript
- Homepage: eventbrite.github.com
- Size: 61.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# An Eventbrite API client library. (requires jQuery)
--------------------------------------
written by [@ryanj](http://github.com/ryanjarvinen/), with [ISO 8601 date support](https://github.com/csnover/js-iso8601/) provided by [Colin Snover](https://github.com/csnover/)
# Usage Examples #
The following parameters can be used to initialize the Eventbrite API client:
* `app_key`: (REQUIRED) Eventbrite users can request an API key on the following page: http://www.eventbrite.com/api/key/
* `user_key`: (OPTIONAL) Omitting this parameter will limit access to public data. Providing a user_key is only needed when updating/accessing private information. Each user can find their `user_key` on this page: http://www.eventbrite.com/userkeyapi
* `access_token`: (OPTIONAL) If you are using OAuth2 with Eventbrite, you can also initialize our API client by supplying a user's access_token (instead of supplying an api_key and user_key). For more information on how to get started with OAuth2, see our [OAUTH2-README](https://github.com/ryanjarvinen/Eventbrite.jquery.js/blob/master/OAUTH2-README.md).
* `callback`: for interacting with the API
### Initialize the client:
Eventbrite({'app_key': "YOUR_API_KEY", 'user_key':"YOUR_USER_KEY"}, function(eb_client){ //eb_client interaction goes here... });
OR, if when using an OAuth2 access_token:
Eventbrite({'access_token': "USER_ACCESS_TOKEN"}, function(eb_client){ //eb_client interaction goes here... });
Within the callback, the client can be used to call any of the methods described in the [Eventbrite API Docs](http://developer.eventbrite.com/doc/):
### [ event_search ]( http://developer.eventbrite.com/doc/events/event_search/ )
// parameters to pass to the API
var params = {'city': "San Francisco", 'region':'CA'};
// make a client request, provide another callback to handle the response data
eb_client.event_search( params, function( response ){
console.log( response );
});
### [ event_get ]( http://developer.eventbrite.com/doc/events/event_get/ )
eb_client.event_get( {'id': 123456789 }, function( response ){
// render the event as a ticket widget:
var ticket_widget_html = eb_client.widget.ticket( response.event );
// or, render it as a countdown widget:
var countdown_widget_html = eb_client.widget.countdown( response.event );
console.log( countdown_widget_html + ticket_widget_html );
});
### [ event_list_attendees ]( http://developer.eventbrite.com/doc/events/event_list_attendees/ )
eb_client.event_list_attendees ( {'id': 123456789 }, function( response ){
console.log(response);
});
### [user_list_events]( http://developer.eventbrite.com/doc/users/user_list_events/ )
eb_client.user_list_events ( {}, function( response ){
$( '#target' ).html( eb_client.utils.eventList( response, eb_client.utils.eventListRow ));
});
#### WARNING: user_keys provide privileged access to a user's private data. Keep it secret. Keep it safe.
*__Eventbrite does not recommend storing authentication tokens in client side source.__*
See the included [example.html](https://github.com/ryanjarvinen/Eventbrite.jquery.js/blob/master/example.html) file for a more detailed implementation example.
# Resources #
* License Info
* API Documentation
* API Getting-Started Guide
* Eventbrite API terms and usage limitations
* Eventbrite Branding Guidelines