{ "openapi": "3.0.0", "info": { "title": "Publisher Reviews API Documentation", "description": "\nThis API blueprint is subject to change due to technology restrictions, performance optimizations or changing requirements.\n\n## Environments\nYou will be provided with access to both `staging` and `production` environments. The queues used will determine which environment is used.\n\nPlease note that `staging` environment is for testing only and is provided on a fair usage basis.\n\nOur Production API is located at:\n\n```\nhttps://api.ldex.co/publisher-reviews\n```\n\nOur Staging API is located at:\n```\nhttps://staging-api.ldex.co/publisher-reviews\n```\n\n## Authentication\nEach message payload MUST contain they consumers API Key\n\n## Requesting Reviews\nA json-formatted message is sent placed on an SQS Queue Production: `https://sqs.us-west-2.amazonaws.com/501388824769/request-reviews` and Staging: `https://sqs.us-west-2.amazonaws.com/501388824769/dev-request-reviews`\n\n```\n{\n 'job':'App\\\\Jobs\\\\RequestReviews',\n 'data':{\n 'api_key':'client-api-key',\n 'foreign_key':'12345',\n 'lazy':true,\n 'business':{\n 'id':'1234567890',\n 'name':'Hilton',\n 'address':{\n 'street':'333 Farrell Street',\n 'city':'San Francisco',\n 'state':'CA',\n 'zip':'94102'\n },\n 'phone':',\n 'description':',\n 'tags':[]\n },'publishers':{\n 'publisher.com':{\n 'profile_key':'http:\\/\\/publisher.com\\/business\\/profile',\n 'last_review_hashes':[\n '9487e4202954d101e15e95cc06a8c4e8',\n '6bb1a0e4195079f58506c60633cb20cc',\n 'ceb5771ddd6ad12a036278263429de29',\n 'a034bbbbf6ea8e6995c3c409f996642d'\n ],\n 'first_page_only': false,\n 'persona': {\n 'additional_cookies': {\n 'login': [\n {\n 'name' : 'Cookie_Name',\n 'value' : 'Cookie_Vlaue',\n 'domain': 'Cookie_domain',\n },\n {\n 'name' : 'Cookie_Name',\n 'value' : 'Cookie_Vlaue',\n 'domain': 'Cookie_domain',\n },\n ]\n }\n },\n }\n }\n }\n}\n```\nThe `job key` should be `App\\Jobs\\RequestReviews` indicating that you are requesting reviews.\n\nThe `API Key` is placed in the `data` array. This is used to authenticate the client.\n\nThe `foreign_key` key is used to identify the request by external id. It will be returned in the results messages\n\nThe `lazy` is a boolean variable which set to true to increase timeout limit for request. set to true when your request need to scrape large number of reviews.\n\nThe `Business` data is placed in `data->business`. This data will be used to `search` for a business profile if no profile_key is provided.\n\nFor each `Publisher` that reviews are requested for, a matching item should be\nplaced in the `data->publishers` array. The array key should be the `name of the\npublisher` as provided by Publisher Reviews Service.\n\nThe `profile`_key is the `public URL or Id` for the required business at the publisher.\n\nThe `last_review_hashes` is a list of hashes\nreturned in previous responses. These should be the last reviews received to prevent\nPublisher Reviews Service from returning all found results.\n\nThe `first_page_only` is a boolean which will give reviews from the first page of latest reviews from publisher site if it is `true` otherwise it will give reviews of all pages from publisher site if it is `false`\n\nThe `login` in `additional_cookies` is the array of login cookies. You can get login cookies from respective publisher site after login at publisher site. Login cookies are only required for 'facebook.com' and 'yelp.com'.\n\n## Supported Publishers\nWe are Supporting following Publishers.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Publishers	Publishers Key
Airbnb	airbnb.com
Angieslist	angieslist.com
Apartmentguide	apartmentguide.com
Apartmentratings	apartmentratings.com
Apartments	apartments.com
Aplaceformom	aplaceformom.com
Bbb	bbb.org
Carfax	carfax.com
Caring	caring.com
Citysearch	citysearch.com
Clearsurance	clearsurance.com
Dealerrater	dealerrater.com
Edmunds	edmunds.com
Expedia	expedia.com
Facebook	facebook.com
Foursquare	foursquare.com
Gayot	gayot.com
Glassdoor	glassdoor.com
Golfnow	golfnow.com
Greatschools	greatschools.org
Grubhub	grubhub.com
Healthgrades	healthgrades.com
Homeadvisor	homeadvisor.com
Homestars	homestars.com
Houzz	houzz.com
Indeed	indeed.com
Judysbook	judysbook.com
Lawyers	lawyers.com
Googlemaps	maps.google.com
Opentable	opentable.com
Orbitz	orbitz.com
Ratemds	ratemds.com
Realself	realself.com
Superpages	superpages.com
Theknot	theknot.com
Travelocity	travelocity.com
Tripadvisor	tripadvisor.com
Trustpilot	trustpilot.com
Vitals	vitals.com
Weddingwire	weddingwire.com
Wellness	wellness.com
Yellowpages	yellowpages.com
Yelp	yelp.com
Zillow	zillow.com
Zocdoc	zocdoc.com
Zomato	zomato.com

\n\n\n`Note`: List denotes the publishers that supported by system, But request can be served only when the client is allowed to consume specific publisher.\n\n\n\n## Getting Responses\nA json-formatted message will be placed on a `unique queue per client`. The message will contain information on a `single publisher`.\n\n```\n{\n 'foreign_key':'12345',\n 'batch_id':'A65orb5vlJ9gByQw',\n 'task_id':'XPeZ3bBLwOQDRkrQ',\n 'task_status':200,\n 'business':{\n 'id':'1234567890',\n 'name':'Hilton',\n 'address':{\n 'street':'333 Farrell Street',\n 'city':'San Francisco',\n 'state':'CA',\n 'zip':'94102'\n },\n 'phone':',\n 'description':',\n 'tags':[]\n },\n 'publisher':'publisher.com',\n 'profile_key':'http:\\/\\/publisher.com\\/business\\/profile',\n 'reviews_urls':[\n 'https:\\/\\/s3-us-west-2.amazonaws.com\\/publisher-reviews-bucket\\/XPeZ3bBLwOQDRkrQ.jl'\n ],\n 'histogram': {\n 'primary': {\n 'score':9.5,\n 'total_reviews':421\n }\n }\n}\n```\nIf a start message contains 5 publishers, there will be 5 messages placed on the finished queue, one for each publisher.\n\n## Task Statuses\n - `200` - OK\n - `400` - No business page found. Possible incorrect `profile_key` supplied\n - `404` - Could not find Business\n - `422` - Invalid Payload\n - `460` - Business has no reviews\n - `461` - Business has no new reviews\n - `500` - Internal Server Error\n - `503` - Service Unavailable\n - `504` - Process Timed Out\n\nAn example of the content of the `reviews_urls` link follows. The fields `text` and `author_name` are base64 encoded.\n\n```\n{'rating': 5, 'review_hash': '9487e4202954d101e15e95cc06a8c4e8', 'text': 'R3JlYXQgc3RhZmYgZ3JlYXQgZm9vZCB3YWxrIGluIGNhcnJ5IG91dCB0aGF0IHNpbXBsZQ==', 'posted_at': 1475259474, 'author_name': 'SmFuZXQgSGFydC1XZWF0aGVyYnk=', 'source_date': '6 months ago', 'scraped_at': 1490984274}\n{'rating': 5, 'review_hash': '6bb1a0e4195079f58506c60633cb20cc', 'text': 'V2Ugd2FudGVkIHF1aWNrIGVhc3kgZGlubmVyLiBBbmQgd2Fsa2VkIGludG8gbGl0dGxlIGNlYXNlcnMuIFRoZSBtb21lbnQgd2Ugd2Fsa2VkIGluIHRoZSBzdGFmZiB3YXMgZnJpZW5kbHksIHNtaWxpbmcsIGFuZCBzcG9pbGVkIHRoZSAzIGtpZHMgSSBoYWQgd2l0aCBtZS4gQ29va2llcyBhbmQgYmFsbG9ucy4gSXQgd2FzIGluc2FuZSB0byBoYXZlIHRoYXQgdHlwZSBvZiBob3NwaXRhbGl0eS4gSSB3aWxsIGJ1eSB0aGVyZSBhbGwgdGhlIHRpbWUgbm93LiBUaGFuayB5b3Ugc3RhZmYgYXQgbGl0dGxlIGNlYXNlcnMh', 'posted_at': 1469989074, 'author_name': 'UmVuZWUgUGllcnBvbnQ=', 'source_date': '8 months ago', 'scraped_at': 1490984274}\n{'rating': 2, 'review_hash': 'ceb5771ddd6ad12a036278263429de29', 'text': 'SXQncyBhbHJpZ2h0LCBzb21ldGltZXMgSSBnbyBpbiBhdCA1cG0gYW5kIHRoZXJlIGlzIG5vIGNyYXp5IGJyZWFkIHJlYWR5LCBwcmV0dHkgY3JhenkgY29uc2lkZXJpbmcgdGhpcyBpcyBhIExpdHRsZSBDYWVzYXJzLg==', 'posted_at': 1462040274, 'author_name': 'RGFuaWVsIE0gUHVnaA==', 'source_date': '11 months ago', 'scraped_at': 1490984274}\n{'rating': 5, 'review_hash': 'a034bbbbf6ea8e6995c3c409f996642d', 'text': null, 'posted_at': 1459448274, 'author_name': 'WW91bmcgTWlj', 'source_date': 'a year ago', 'scraped_at': 1490984274}\n```\n\n## Errors\nShould there be an error processing the request, a json-formatted message will be placed on a `customer-specific SQS queue`.\n\nThe message will contain the `payload` we received and a description of the `error` for your review.\n\n```\n{\n 'error':{\n 'code':401,\n 'message':'Invalid ApiKey!'\n },\n 'payload':{\n 'api_key':'client-api-key',\n 'foreign_key':'12345'\n 'business':{\n 'id':'1234567890',\n 'name':'Hilton',\n 'address':{\n 'street':'333 Farrell Street',\n 'city':'San Francisco',\n 'state':'CA',\n 'zip':'94102'\n },\n 'phone':',\n 'description':',\n 'tags':[]\n },'publishers':{\n 'publisher.com':{\n 'profile_key':'http:\\/\\/publisher.com\\/business\\/profile',\n 'last_review_hashes':[\n '9487e4202954d101e15e95cc06a8c4e8',\n '6bb1a0e4195079f58506c60633cb20cc',\n 'ceb5771ddd6ad12a036278263429de29',\n 'a034bbbbf6ea8e6995c3c409f996642d'\n ]\n }\n }\n }\n}\n\n```\nCurrent supported error codes are:\n\n - `400` - Bad Request\n - `401` - Unauthenticated\n\nReview the `error->message` for more detailed description of the error.\n\n\n## System Status\n\n