Hi all,
IntroductionYelp'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.0Version: 1.0.0Technology: REST
API yelp API v2.0 using the REST.
AuthenticationAPI 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].OperationsFollowing
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 Parameterscc: 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 LocationSpecify Location by Geographical Bounding
Boxsw_latitude: Southwest latitude of bounding boxsw_longitude: Southwest
longitude of bounding boxne_latitude: Northeast latitude of bounding
boxne_longitude: Northeast longitude of bounding boxSpecify Location by
Geographic Coordinatelatitude: Latitude of geo-point to search nearlongitude:
Longitude of geo-point to search nearaccuracy: Accuracy of latitude,
longitudealtitude: Altitudealtitude_accuracy: Accuracy of altitudeSpecify
Location by Neighborhood, Address, or Citylocation: Specifies the combination
of "address, neighborhood, city, state or zip, optional country" to be used
when searching for businesses. latitude: Latitude of current locationlongitude:
Longitude of current locationBusiness API [3]Locale Parameterscc: 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
