FeedCheck offers an API in order to help consumer brands easily integrate review management into their platforms. Below you will find the technical documentation required for your integration.
The first interaction with our API is the authentication. The FeedCheck API uses Basic Authentication with username and password (Secret API Key). You can find this information in the Settings section ( https://app.feedcheck.co/settings ). The Secret API Key needs to be included in any of the following API calls. Otherwise, a 401 error code with the message "Could not verify your access level for that URL" will be returned.
In FeedCheck, a product is defined by a group of links, each link pointing out to a product page (e.g. https://www.amazon.com/Apple-iPhone-Fully-Unlocked-5-8/dp/B075QNGDZD/ ).
For adding a product you need to make a POST request at /api/products endpoint with the following payload:
{
"name":"product name",
"owner":"my product"
}
where "name" contains your product name and owner contains "my product" or "competitor" value.
curl -X POST https://app.feedcheck.co/api/products
-H "Content-Type: application/json"
-u username:password
-d '{"name":"product name", "owner":"my product"}'
where username and password are auth informations.
Retrieving products from your account is done by GET request at /api/products . The response has the following format:
[
{
"id": 3350,
"owner": "my product",
"customer": 965,
"groups": [],
"name": "Spray LOreal Paris Magic Retouch"
},
{
"id": 3351,
"owner": "my product",
"customer": 965,
"groups": [],
"name": "Lipstick LOreal Paris Infaillible"
}
]
Below is the request in cURL format:
curl -X GET https://app.feedcheck.co/api/products -H "Content-Type: application/json" -u username:password
In FeedCheck the products can be deleted one by one by DELETE request at /api/products/{productID} .
curl -X DELETE https://app.feedcheck.co/api/products/9999 -H "Content-Type: application/json" -u username:password
In FeedCheck the links are the places from where reviews are collected. A link point to a product page. All links belong to products, as we mentioned previously.
Adding a link to a product is done by a POST request at /api/products/{productId}/links endpoint with the following payload:
{
"link":"https://www.amazon.com/Apple-iPhone-Fully-Unlocked-5-8/dp/B075QNGDZD/"
}
Retrieving links for a specific product is done by GET request at /api/products/{productId}/links . The response has the following format:
[
{
"id": 31978,
"productLink": "https://www.amazon.com/Apple-iPhone-Fully-Unlocked-5-8/dp/B075QNGDZD/",
"productDataCreated": 0,
"httpStatus": 0,
"productName": "",
"productStatus": "Processing",
"domain": "amazon.com",
"product": 3351,
"customer": 965
}
]
Retrieving reviews for a specific product is done by GET request at /api/products/{productId}/reviews.
If you want to get reviews that are newer than a certain date you can use the URL param start_timestamp with a timestamp in UNIX format.
You can also use end_timestamp to get reviews older than a specific date. If you want to limit the response size you can use the limit param.
The response has the following format:
[
{
"id": 12551741,
"verified": true,
"reviewStatus": "unread",
"productLink": 31978,
"reviewUserProfile": "",
"language": "en",
"reviewDataDiscovered": 1486447200,
"reviewWebsite": "amazon.com",
"reviewDataCreated": 1486447200,
"size": "",
"reviewSignature2": "6e66106d4eacec5761e24728f2ace8e7",
"reviewSignature": "843fbd531ea438fdc3fcbedeb7dcedcb",
"color": "",
"reviewRating": "4.0",
"reviewUser": "Ofelia P.",
"reviewTitle": "Beautiful phone, happy with the upgrade",
"reviewExternalId": "1236474",
"lastSeen": 1486447200,
"style": "",
"reviewData": 1486447200,
"reviewContent": "Phone freezes a bit and I need to reboot but that is maybe once a week. I am hopeful that a future update will fix this. Annoying that it doesn't read my face properly when I am wearing my glasses. Not many apps are up to the speed with the facial scan so I need to type in my password every time I check my banking statements. The missing fingerprint button took some time getting used to but once I did, I don't even miss it. The camera is lovely as is the speed. I wish there were more color and size choices, but prob next year.",
"reviewLink": "https://www.amazon.com/Apple-iPhone-Fully-Unlocked-5-8/dp/B075QNGDZD/",
"alerted": true
}
]
Where "lastSeen" is updated only for customers who requested delete/change detection for the reviews.
The Delete / Change detection is available only for customers who requested this feature.
Detection of the reviews changed or deleted is done by comparing "lastSeen" field of the review with current timestamp - 7 days time interval like in the following snippet:
lastSeen < currentTimestamp - 604800. If the value of the previous comparison is true this means that review may be deleted or changed.
Retrieving all groups in your account is done by GET request at /api/groups .
The response has the following format:
[
{
"id": 123,
"name": "The group name"
}
]
Retrieving all products in a specific group is done by GET request at /api/groups/{groupId}/products .
The response has the same format as retrieving products endpoint.
Retrieving all products in a specific group is done by GET request at /api/groups/{groupId}/reviews .
The response has the same format as reviews endpoint.
If you have different products with the same links in a group you may receive duplicate reviews.
If you want to deduplicate reviews use the query parameter deduplicate=1