3. What is YellowAPI? Allows developers to access 1.5 million Canadian business listings All listings are located with their latitude and longitude Free to use If you develop a successful app the Yellow Pages will pay you Currently in Beta
5. YellowAPI Basics Register to use Granted two API keys: Sandbox API Key (development) Live API Key To begin with only Sandbox key will be activated Once your application is complete Yellow Pages will review it and activate the live key Calls to API rate limited but limit is negotiable Some restrictions on how data is used
6. API Architecture REST architecture All methods accessed via GET Responses returned as XML (default) or JSON Four methods currently available: FindBusiness GetBusinessDetails FindDealer GetTypeAhead
8. Findbusiness What Where search ‘What’ can be a category, business name or anything in between ‘Where’ can be passed in two ways: Place (e.g. Guelph, ON) Lat/Lon point. If place is passed as Lat/Lon each result is returned with distance to search point calculated and in order from closest to furthest Results returned in chunks of 40 by default
9. GetBusinessdetails Method still being finalised Provides full details on an individual business Data available ranges from address, opening hours to adverts, videos and logos Need a listing id (retrieved from FindBusiness) to call this method
10. Finddealer Used to return a list of all dealers/franchises for a business Listing can be a ‘parent’ or ‘child’ listing if it falls into this category FindBusiness will indicate if a listing is/has a parent
11. Gettypeahead Method not yet available Used to return suggestions based on what a user has typed Can return suggestions for what or where For example, if a user enters ‘res’ for what ‘restaurant’ could be returned, along with other suggestions
13. YellowAPI resources Check out http://www.yellowapi.com Full documentation on the API, support forums, app gallery and SDK’s in many languages Lots of support available from Yellow Pages staff Big plans for future of API including deals/offers and reviews
Mention that this will be a high level overview. Look at yellowapi.com for full details.
Emphasise Canadian only content.
Restrictions include no caching, no re-ordering of data
Discuss how API only allows retrieval of information, not adding to it.
Mention how API also returns details of overall number of results, current page number. Able to pass argument in determining which page of results is returned.
Emphasise that I haven’t tried this method
Mention how this is up to the developer. At this point introduceRendezview.