Hi vanjikumaran,



Okay. Thank you for the comments. We'll Discuss on the project plan.




Best Regards,
R.Jarachanthan

Date: Thu, 12 Jun 2014 22:17:37 +0530
From: [email protected]
To: [email protected]
Subject: Re: [Architecture] Connector:Yelp

Seems like YELP got only 2 API available with some set of parameter for them. 
It seems okay to me. Lets come up with the with the project plan.


On Thu, Jun 12, 2014 at 9:59 PM, Jarachanthan Ratnakumar 
<[email protected]> wrote:





Hi all,
     
Introduction

Yelp's API program enable to access trusted Yelp information in real time, such 
as business listing info, overall business ratings and review counts, deals and 
recent review excerpts. Yelp Platform allows 3rd party developers to integrate 
their transaction services for local businesses directly on Yelp sites and 
apps. 




Connector Name: yelp-connector-1.0.0



Version: 1.0.0



Technology: REST


API 

yelp API v2.0 using the REST.


Authentication

API requests must be authenticated in compliance with the OAuth 1.0a 
specification.

Each request must contain the following OAuth protocol parameters:These 
parameters may be passed in the HTTP (Authorization) header, as URL query keys, 
or in the POST data. Generating the OAuth signature is done by applying the 
HMAC-SHA1 with the oauth_token_secret [1].

Operations

Following listed methods are the operations and we have decided to use these 
from API.


Selected methods:




Search API [2]



General Parameters 



term: Search term (e.g. "food", "restaurants"). If term isn't included we 
search everything.



limit: Number of business results to return.



offset: Offset the list of returned business results by this amount.



sort: Sort mode: 0=Best matched (default), 1=Distance, 2=Highest Rated. If the 
mode is 1 or 2 a search may retrieve an additional 20 businesses past the 
initial limit of the first 20 results. This is done by specifying an offset and 
limit of 20. Sort by distance is only supported for a location or geographic 
search. The rating sort is not strictly sorted by the rating value, but by an 
adjusted rating value that takes into account the number of ratings, similar to 
a bayesian average. This is so a business with 1 rating of 5 stars doesn't 
immediately jump to the top.



category_filter: Category to filter search results with. See the list of 
supported categories. The category filter can be a list of comma delimited 
categories. For example, 'bars,french' will filter by Bars and French. The 
category identifier should be used (for example 'discgolf', not 'Disc Golf').



radius_filter: Search radius in meters. If the value is too large, a 
AREA_TOO_LARGE error may be returned. The max value is 40000 meters (25 miles).



deals_filter : Whether to exclusively search for businesses with deals.



Locale Parameters



cc: ISO 3166-1 alpha-2 country code. Default country to use when parsing the 
location field. United States = US, Canada = CA, United Kingdom = GB (not UK). 



lang: ISO 639 language code (default=en). Reviews and snippets written in the 
specified language will be shown.



Methods of Specifying Location



Specify Location by Geographical Bounding Box



sw_latitude: Southwest latitude of bounding box



sw_longitude: Southwest longitude of bounding box



ne_latitude: Northeast latitude of bounding box



ne_longitude: Northeast longitude of bounding box



Specify Location by Geographic Coordinate



latitude: Latitude of geo-point to search near



longitude: Longitude of geo-point to search near



accuracy: Accuracy of latitude, longitude



altitude: Altitude



altitude_accuracy: Accuracy of altitude



Specify Location by Neighborhood, Address, or City



location: Specifies the combination of "address, neighborhood, city, state or 
zip, optional country" to be used when searching for businesses. 



latitude: Latitude of current location



longitude: Longitude of current location



Business API [3]



Locale Parameters



cc: ISO 3166-1 alpha-2 country code. Default country to use when parsing the 
location field. United States = US, Canada = CA, United Kingdom = GB (not UK).



lang:ISO 639 language code (default=en). Reviews and snippets written in the 
specified language will be shown.



lang_filter: Whether to filter business reviews by the specified lang


Let me know your suggestions about this API and our decision on creating 
connector for this yelp API v2.


[1] http://www.yelp.com/developers/documentation/v2/authentication

[2] http://www.yelp.com/developers/documentation/v2/search_api

[3] http://www.yelp.com/developers/documentation/v2/business



Thank you
R.Jarachanthan
                                          

_______________________________________________

Architecture mailing list

[email protected]

https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture




-- 
Sivajothy Vanjikumaran
Senior Software Engineer

Integration Technologies TeamWSO2 Inc. http://wso2.com


Mobile:(+94)777219209    



This communication may contain privileged or other confidential information and 
is intended exclusively for the addressee/s. If you are not the intended 
recipient/s, or believe that you may have received this communication in error, 
please reply to the sender indicating that fact and delete the copy you 
received and in addition, you should not print, copy, re-transmit, disseminate, 
or otherwise use the information contained in this communication. Internet 
communications cannot be guaranteed to be timely, secure, error or virus-free. 
The sender does not accept liability for any errors or omissions





_______________________________________________
Architecture mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture                     
                  
_______________________________________________
Architecture mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Reply via email to