BooRah Syndication Platform

BooRah Syndication API provides you the capability to integrate restaurant listings, rating, summaries and search capabilities in your own web pages with JavaScript.



How do I get Started

If you do not have a account already and would like to be a partner, please email info@boorah.com or visit Partner Page.
If you are a partner and would like a key, please email webmaster@boorah.com.
For Version 2.0 of Integration API, visit Version 2.x Integration Guide
For BooRah Review Summary & Blog Widgets API, visit Widget Integration Guide
Otherwise, you are ready to proceed.


What can I do with the API


Modules (Fully Embedded)

The Supported API version for this document is 1.01 beta.
The following modules can be fully embedded within your webpages

  • Search - Includes search by name, cuisine and location. Location can be a neighborhood, city, state, zip, intersection or points of interest.

  • Restaurant List - Based on search parameter, this lets you render the results. Restaurant name, address, city, state, zip and phone number are provided. In addition, where available, ratings and summaries from user reviews are also displayed. Convenience links to Maps/Directions are also displayed.

  • Detail - By selecting any one of the restaurants in the restaurant list, you can drill down to get additional detail. The detail includes additional information such as business hours, price, and specific ratings for food, service and ambiance where available. In addition, short snippets to additional reviews and links to their sources are also displayed.

  • Write Review - Captures user review including user name/alias, rating, and review text for a restaurant

Modules (External Links)

The following modules are links to external sites from your webpages. In all these cases, a new window/tab is invoked.

  • Maps/Directions - Links to BooRah server webpage with partner branding

  • Review Links - Links to BooRah and original external sources

  • Update Information - Provides the ability for users to update basic information about a business, such as cuisines, business hours or phone number. Links to BooRah server with partner branding

  • Review Notification - Provides notification when a new review has been added from partner site

  • Detail - By selecting any one of the restaurants in the restaurant list, you can drill down to get additional detail. The detail includes additional information such as business hours, price, and specific ratings for food, service and ambiance where available. In addition, short snippets to additional reviews and links to their sources are also displayed.

  • Write Review - Captures user review including user name/alias, rating, and review text for a restaurant


Module names and parameters

    modVSearch
  • Lays out a search box in three sections. Top section - name/cuisine, Middle section - Location(neighborhood, city, zip), Last section - Search button

  • Required parameters
    var boorah_search_results_page="search_results.htm"; - Indicates html where results will be rendered
    var boorah_default_location="Mid Peninsula,CA"; - Prepopulates the location field
    var boorah_server_url="boorah server url" - server that supports this service

  • Sample Usage

    Head Section

    <link href="http://business.intuit.com/boorah-syndication/css/syndicate.css" rel="stylesheet" type="text/css" />

    Within Body

    <script type="text/javascript">
    var boorah_search_results_page="search_results.htm";
    var boorah_default_location="Mid Peninsula,CA";
    <script>
    <script type="text/javascript" src="http://business.intuit.com/boorah-syndication/syndication?key=KEY&module=modVSearch">
    <script>


    modHSearch

  • Lays out a search box in three sections. Top section - name/cuisine, Middle section - Location(neighborhood, city, zip), Last section - Search button

  • Required parameters
    var boorah_search_results_page="search_results.htm"; - Indicates html where results will be rendered
    var boorah_default_location="Mid Peninsula,CA"; - Prepopulates the location field
    var boorah_server_url="boorah server url" - server that supports this service

  • Sample Usage

    Head Section

    <link href="http://business.intuit.com/boorah-syndication/css/syndicate.css" rel="stylesheet" type="text/css" />

    Within Body

    <script type="text/javascript">
    var boorah_search_results_page="search_results.htm";
    var boorah_default_location="Mid Peninsula,CA";
    <script>
    <script type="text/javascript" src="http://business.intuit.com/boorah-syndication/syndication?key=KEY&module=modHSearch">
    <script>


    modSearchResults

  • Renders all the search results based on user query

  • Required parameters
    var boorah_display_detail_page="detail.htm"; - Indicates html where details will be rendered
    var boorah_server_url="boorah server url" - server that supports this service
    var boorah_search_bar_type="regular_search"; - Embeds a search box within the results ( at the top)
    var boorah_search_bar_rows="1"; - Options are 1,2,3. 1 indicates all the fields are laid oud in one row. 2 is equiv of modHSearch, 3 is equiv of modVSearch
    var boorah_search_results_page="search_results.htm"; - Indicates html where search results will be rendered, used for queries originating from same page

  • Sample Usage

    Head Section

    <link href="http://business.intuit.com/boorah-syndication/css/syndicate.css" rel="stylesheet" type="text/css" />

    Within Body

    <script type="text/javascript">
    var boorah_display_detail_page="detail.htm";
    var boorah_search_bar_type="regular_search";
    var boorah_search_bar_rows="1";
    var boorah_search_results_page="search_results.htm";
    var boorah_server_url="http://business.intuit.com/boorah-syndication/"
    <script>
    <script type="text/javascript" src="http://business.intuit.com/boorah-syndication/syndication?key=KEY&module=modSearchResults">
    <script>



    modDisplayDetail

  • Renders all the details associated with a restaurant

  • Required parameters
    var boorah_display_detail_page="detail.htm"; - Indicates html where details will be rendered
    var boorah_write_review_form="review.htm"; - Indicates html where reviews will be written
    var boorah_server_url="boorah server url" - server that supports this service

  • Sample Usage

    Head Section

    <link href="http://business.intuit.com/boorah-syndication/css/syndicate.css" rel="stylesheet" type="text/css" />

    Within Body

    <script type="text/javascript"> var boorah_display_detail_page="detail.htm";
    var boorah_write_review_form="review.htm";
    var boorah_server_url="http://business.intuit.com/boorah-syndication/"
    <script>
    <script type="text/javascript" src="http://business.intuit.com/boorah-syndication/syndication?key=KEY&module=modDisplayDetail">
    <script>


    modWriteReviewForm

  • Renders a write a review form

  • Required parameters
    var boorah_review_accepted_url="postReview.htm"; - Indicates html where responses to a review submission will be handled ( error handling and follow on actions)
    var boorah_display_detail_page="detail.htm"; - Indicates html where details will be rendered
    var boorah_server_url="boorah server url" - server that supports this service

  • Sample Usage

    Head Section

    <link href="http://business.intuit.com/boorah-syndication/css/syndicate.css" rel="stylesheet" type="text/css" />

    Within Body

    <script type="text/javascript"> var boorah_review_accepted_url="postReview.htm";
    var boorah_display_detail_page="detail.htm";
    var boorah_server_url="http://business.intuit.com/boorah-syndication/"
    <script>
    <script type="text/javascript" src="http://business.intuit.com/boorah-syndication/syndication?key=KEY&module=modWriteReviewForm">
    <script>


    modPostReview

  • Page that handles errors from review posts and also follow-on display items

  • Required parameters
    var boorah_review_accepted_url="postReview.htm"; - Indicates html where responses to a review submission will be handled ( error handling and follow on actions)
    var boorah_write_review_form="review.htm"; - Indicates html where write a review form will be rendered
    var boorah_display_detail_page="detail.htm"; - Indicates html where details will be rendered
    var boorah_server_url="boorah server url" - server that supports this service

  • Sample Usage

    Head Section

    <link href="http://business.intuit.com/boorah-syndication/css/syndicate.css" rel="stylesheet" type="text/css" />

    Within Body

    <script type="text/javascript"> var boorah_review_accepted_url="postReview.htm";
    var boorah_write_review_form="review.htm";
    var boorah_display_detail_page="detail.htm";
    var boorah_server_url="http://business.intuit.com/boorah-syndication/"
    <script>
    <script type="text/javascript" src="http://business.intuit.com/boorah-syndication/syndication?key=KEY&module=modPostReview">
    <script>




Example


The following sequence demonstrates an application developed using the above API


How to customize CSS


The current implementation uses a simple stylesheet to manage fonts and some placement. It can found here . If you would like to change specific items, you may override it based on following guidelines. Please note that making such changes may lead to unintended UI modifications.

  • <div class="boorah_header2">

  • <div class="boorah_title1">
  • <div class="boorah_title2">
  • <div class="boorah_title3">
  • <div class="boorah_text1">
  • <div class="boorah_text1b">
  • <div class="boorah_text2">
  • <div class="boorah_text2b">
  • <div class="boorah_small1">
  • <div class="boorah_error2">


©2007 Boorah, Inc