YellowAPIA brief introduction to the API from the Yellow Pages
What is it?
What is YellowAPI?Allows developers to access 1.5 million Canadian business listingsAll listings are located with their latitude and longitudeFree to useIf you develop a successful app the Yellow Pages will pay youCurrently in Beta
How can I use it?
YellowAPI BasicsRegister to useGranted two API keys:Sandbox API Key (development)Live API KeyTo begin with only Sandbox key will be activatedOnce your application is complete Yellow Pages will review it and activate the live keyCalls to API rate limited but limit is negotiableSome restrictions on how data is used
API ArchitectureREST architectureAll methods accessed via GETResponses returned as XML (default) or JSONFour methods currently available:FindBusinessGetBusinessDetailsFindDealerGetTypeAhead
API Methods
FindbusinessWhat 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 furthestResults returned in chunks of 40 by default
GetBusinessdetailsMethod still being finalisedProvides full details on an individual businessData available ranges from address, opening hours to adverts, videos and logosNeed a listing id (retrieved from FindBusiness) to call this method
FinddealerUsed to return a list of all dealers/franchises for a businessListing can be a ‘parent’ or ‘child’ listing if it falls into this categoryFindBusiness will indicate if a listing is/has a parent
GettypeaheadMethod not yet availableUsed to return suggestions based on what a user has typedCan return suggestions for what or whereFor example, if a user enters ‘res’ for what ‘restaurant’ could be returned, along with other suggestions
Where can I find out more?
YellowAPI resourcesCheck out http://www.yellowapi.comFull documentation on the API, support forums, app gallery and SDK’s in many languagesLots of support available from Yellow Pages staffBig plans for future of API including deals/offers and reviews
What kind of apps can I build with it?
ThanksFeel free to contact me:Twitter: JCook21Email: jeremycook0@gmail.comBlog: http://jeremycook.caRendezview:http://rendezview.caTwitter: RendezviewappYellow API:http://www.yellowapi.com

Yellow api

  • 1.
    YellowAPIA brief introductionto the API from the Yellow Pages
  • 2.
  • 3.
    What is YellowAPI?Allowsdevelopers to access 1.5 million Canadian business listingsAll listings are located with their latitude and longitudeFree to useIf you develop a successful app the Yellow Pages will pay youCurrently in Beta
  • 4.
    How can Iuse it?
  • 5.
    YellowAPI BasicsRegister touseGranted two API keys:Sandbox API Key (development)Live API KeyTo begin with only Sandbox key will be activatedOnce your application is complete Yellow Pages will review it and activate the live keyCalls to API rate limited but limit is negotiableSome restrictions on how data is used
  • 6.
    API ArchitectureREST architectureAllmethods accessed via GETResponses returned as XML (default) or JSONFour methods currently available:FindBusinessGetBusinessDetailsFindDealerGetTypeAhead
  • 7.
  • 8.
    FindbusinessWhat 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 furthestResults returned in chunks of 40 by default
  • 9.
    GetBusinessdetailsMethod still beingfinalisedProvides full details on an individual businessData available ranges from address, opening hours to adverts, videos and logosNeed a listing id (retrieved from FindBusiness) to call this method
  • 10.
    FinddealerUsed to returna list of all dealers/franchises for a businessListing can be a ‘parent’ or ‘child’ listing if it falls into this categoryFindBusiness will indicate if a listing is/has a parent
  • 11.
    GettypeaheadMethod not yetavailableUsed to return suggestions based on what a user has typedCan return suggestions for what or whereFor example, if a user enters ‘res’ for what ‘restaurant’ could be returned, along with other suggestions
  • 12.
    Where can Ifind out more?
  • 13.
    YellowAPI resourcesCheck outhttp://www.yellowapi.comFull documentation on the API, support forums, app gallery and SDK’s in many languagesLots of support available from Yellow Pages staffBig plans for future of API including deals/offers and reviews
  • 14.
    What kind ofapps can I build with it?
  • 15.
    ThanksFeel free tocontact me:Twitter: JCook21Email: jeremycook0@gmail.comBlog: http://jeremycook.caRendezview:http://rendezview.caTwitter: RendezviewappYellow API:http://www.yellowapi.com

Editor's Notes

  • #2 Mention that this will be a high level overview. Look at yellowapi.com for full details.
  • #4 Emphasise Canadian only content.
  • #6 Restrictions include no caching, no re-ordering of data
  • #7 Discuss how API only allows retrieval of information, not adding to it.
  • #9 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.
  • #11 Emphasise that I haven’t tried this method
  • #15 Mention how this is up to the developer. At this point introduceRendezview.