Import reviews to Cackle

HTTP метод Endpoint Time limit Comments
POST http://cackle.me/api/3.0/review/post.json 1 in every 5 seconds Import of reviews from site page. Request data encoding UTF-8.

Request parameters:

Parameter Description Comments
id The widget ID You can get in the admin panel on Reviews tab, menu "Install" tab "CMS Platform" and choose Bitrix.
siteApiKey The widget API key You can get in the admin panel on Reviews tab, menu "Install" tab "CMS Platform" and choose Bitrix.
accountApiKey The account API key You can get in the admin panel on Reviews tab, menu "Install" tab "CMS Platform" and choose Bitrix.
reviews The reviews list in JSON format

Example of parameter reviews:

{
  "chan": "12345",
  "url": "http://site.com/product12345",
  "title": "My site | Product 12345",
  "reviews": [{
    "id": "111",
    "star": "5",
    "pros": "Good",
    "cons": "Bad",
    "comment": "Comments",
    "recom": "true",
    "up": "8",
    "down": "0",
    "ip": "84.195.0.32",
    "status": "approved",
    "created": "1422820372367",
    "user": {
      "id": "808",
      "name": "Tom Cat",
      "email": "tomcat@example.org",
      "avatar": "//yourscr.com/40cc32af4753cdee62f527ef8ebe37df.png"
    }
  }, {
    "id": "888",
    "star": "3",
    "comment": "Ok",
    "media": "http://cackle.me/static/img/flat-comment.png http://cackle.me/static/img/flat-review.png",
    "ip": "40.105.4.195",
    "status": "approved",
    "created": "1425412776446",
    "name": "San",
    "email": "san@example.org"
  }]
}

Description of fields for the page:

Parameter Mandatory Description Comments
chan No ID to which will be attached reviews on the page of your website By default, this url without Protocol and Domain. For example: for address http://example.org/product/12345, chan will be /product/12345.
If your site uses a CMS (Bitrix, OpenCart), chan is the post_ID from the database.
url Yes URL
title No Page title Usually taken from <title>...</title> tag on the page.

Description of fields reviews:

Parameter Mandatory Description Comments
id Yes Review ID Unique within a one widget.
star Yes Review rating From 1 to 5
pros No Pros
cons No Cons
comment No Comment
media No Links to images List of links separated by spaces on image formats: png, jpg, gif.
recom No Recommendation true - I recommend this product
false - I do not recommend this product.
up No Positive rating The number of votes positively rated this review.
down No Negative rating The number of votes negatively rated this review.
ip Yes IP address From posted the review.
status Yes Review status Available: pending, approved, spam, deleted. The default is set to approved.
created Yes Creation date In milliseconds.
user Yes, if name, email absent Review author Registered user of your site. If paid service "Single sign-on", then such user can log in under your account.
name No Anonymous name
email No Anonymous email