API

The API is in alpha

We have the beginnings of a simple JSON API for reading and updating venue information.

This API is subject to unannounced breaking changes until it has stabilized.

Register as a user and get an API key to create/update venues.

This isn't currently required for use, but it will be in future. We really just want a way to contact you and to know who is using the API and how much during this alpha period.

HTTP Basic Auth

All requests are authenticated with Basic Auth.

Available routes

GET "http://[username]:[api_key]@gogenie.heroku.com/venue/search.json?query=[your search term]&near=[free text name of a place]&ll=[lat,lng]"

Retrieve a foursquare result set, enriched with accessibility information for any venues that we have in our database.
query is required - Eg. "Royal Albert Hall"
Either near or ll are required as the centre of a geographic search for the search query.
If a venue does not yet exist you will be presented with ["accessibility"]["venue"]["url"] to a /venue/foursquare route. This generates a new venue and redirects to a new venue resource. You should use this new URL for all subsequent requests.

DEPRECATED - we've moved away from IVES GET "http://[username]:[api_key]@gogenie.heroku.com/venue/search.json?venue_name=[your search term]"

Retrieve a list of Venue names, addresses, urls and IDs.

GET "http://[username]:[api_key]@gogenie.heroku.com/venue/foursquare/[foursquare id].json"

Given a foursquare venue ID, retrieve any accessibility information that we have about it. If no information is found, a new venue entry is created and we attempt to scrape our source anything we can asynchronously (could be several days later).

GET "http://[username]:[api_key]@gogenie.heroku.com/venue/[venue slug].json"

This will give you JSON details about a venue.

PUT "http://[username]:[api_key]@gogenie.heroku.com/venue/[venue slug].json"

With the properties you would like to update as POST variables in the body. Eg. venue[mail_email_address]=hello@example.com

GET "http://[username]:[api_key]@gogenie.heroku.com/venue/[venue slug]/[document type singular].json"

Where [document type singular] is one of 'review', 'faq', 'photo', 'video', will give you an index of that type of document.

GET "http://[username]:[api_key]@gogenie.heroku.com/venue/[venue slug]/[document type singular]/[id].json"

Where [document type singular] is one of 'review', 'faq', 'photo', 'video' and [id] is a valid document, will give you that type of document as JSON.

POST "http://[username]:[api_key]@gogenie.heroku.com/venue/[venue slug]/[document type singular].json"

With the properties of the document you would like to create as POST variables in the body. Eg. faq[question]=how&faq[answer]=easily

Editing must be done by hand in the UI.