Table of Contents Hide
As we approach the Hackathon event [November 4th (3 PM onwards), Nov 5th & 6th], we’d like to share details of the partner’s API/what it offers and open up for questions/participation and collaboration etc.
But before we share Zomato API details, we’d also like to tell you that the best hack using the Zomato API will get an iPad2 for free!
And now, about the API (details as shared by Zomato team):
What is the Zomato API all about?
The Zomato API (http://zomato.com/api) was made public with the intention to help developers create innovative web and mobile applications using Zomato’s content. Using the API, developers can access the most updated content available on Zomato in real time directly from within their apps. They can access information such as restaurant listings, location coordinates, reviews, discounts, photos, menus and pretty much everything else that we have for our customers.
The API also lets developers search Zomato’s rich database comprising of ~20,000 restaurants, covering 10 major cities in India, based on various criteria.
What is new in the Zomato API?
We have just included Events to our API. Along with the restaurant details, developers can now get information such as Event listings, categories, venue details, featured/popular/recommended events and top events in the city. Events API is currently in beta. The final structure of the API might be quite different from what we have right now, but we will also support the current version of the API for a few years down the line.
How do Zomato’s mobile apps use the API?
Zomato’s mobile applications use the same API which we have opened up for developers. Our API acts as a layer through which our mobile apps access our database. The API takes the http request as input and breaks it into different variables:
1. Basic Request: – This could be a call to get the number of active cities, or a search for a restaurant based on a keyword, etc.
2. Filter parameters: These are flags on which a search is restricted. For example, a keyword based restaurant search could have a filter for a bar or a buffet
3. The Response Format: XML or JSON
4. API key: A request is processed only if it has a valid API key (sent in the request header)
Once we have have extracted all this information from the request, the API constructs and fires a query on the database. The results are then returned in the specified format. The app then parses this response and displays the data to the user.
Sample request :
1. Basic Request: Search for restaurant
2. Filter parameters: city_id = 1 (delhi)
search keyword = “italian restaurant”
cc = 1 (accepts credit cards)
3. Response format: JSON
Details of all the features provided by our API is provided in the documentation (http://www.zomato.com/api/documentation), along with example code. Further, we have also provided an API Sandbox (http://www.zomato.com/api/sandbox), where you can test your requests.
What can you create using the Zomato API?
We want to create an eco-system of developers and apps who use our content and also help us create content for our platform. With the API, developers can now easily leverage Zomato.com restaurant database into any ‘local’ application. A few other possible applications of the API are listed below:
- A city guide or an augmented reality app
- A local deal app where users can check user reviews and menus for a restaurant which has a deal on offer
- An app linking Zomato’s data to that of Foursquare and Facebook through their APIs. So your friends can share where and what they’re eating and check in (since we also provide restaurant coordinates)
So get your thinking hats on at the Hackathon and unleash your creativeness! The most creative/best use case of our API will win an iPad2 and we also plan to promote innovative applications made with the Zomato API through our website, facebook, twitter page.
- Get together the evening of 4th November and find a team (or get yours)
- Get your business idea sounded with mentors, PI team, others [Hint: This is your pitch session].
- Get together on 5th morning.
- Start coding.
- Go Home (after 7/8 PM or so).
- Get together on 6th morning. Start coding.
- 6th Nov – evening 4 pm – have a prototype ready.
- Demo to mentors, investors, audience, others from 6 pm to 9 pm.
Ask here (in the comment section) or @Facebook group: http://www.facebook.com/groups/unpluggd/
How to block your seat?
Make a choice: