Reviews Simple API

Getting Started

Users can perform basic CRUD on reviews as well as attach comments. There is currently a limit of 100 reviews per account. Reviews can be grouped into categories by tagging them with unique tags representing their parent. Multiple tags can be added to one review to allow for multi-dimensional review structures. In addition to tags, multiple flags are included on reviews, including a flag that allows users to set whether the review spam or not and to set if it's bad/inappropriate.

Reviews

Once you have registered for your own API key, it's easy to get started. Here's the supported methods:

Retrieve all reviews: GET /api/reviews?apikey=xxxxxxxxxxxxxx
Retrieve all reviews by an author: GET /api/authors/{author_slug}?apikey=xxxxxxxxxxxxxx
Retrieve specific review: GET /api/reviews/{id}?apikey=xxxxxxxxxxxxxx
Create new review: POST /api/reviews?apikey=xxxxxxxxxxxxxx
Update an existing review: PUT /api/reviews/{id}?apikey=xxxxxxxxxxxxxx
Delete an existing todo: DELETE /api/reviews/{id}?apikey=xxxxxxxxxxxxxx

Below is what the standard body in a POST or PUT should look like. Everything is optional to allow for maximum flexibility in your review structure. The meta property, if used, must be in JSON format, not exceeding 256 bytes. Meta can be a useful field to store additional data for the review. Rating is a decimal between 0.00 and 1.00. Tags is a comma separated string list.

{
    "tags": "burger-review,best-restaurants-list",
    "title": "Review of Joe's Diner",
    "body": "Best hamburgers around!",
    "rating": 0.80,
    "bad": false,
    "spam": false,
    "helpful_counter": 12,
    "unhelpful_counter": 5,
    "author": "John Doe",
    "author_email": "john@example.com",
    "author_slug": "john-doe-42",
    "reviewed_at": "2016-01-01 10:00:00",
    "meta":
        {
            "created_in": "USA"
        }
}

Retrieve review with comment: GET /api/reviews/{id}?apikey=xxxxxxxxxxxxxx
Create comment: POST /api/reviews/{id}/comments?apikey=xxxxxxxxxxxxxx
Update review's comment: PUT /api/reviews/{review_id}/comments/{comment_id}?apikey=xxxxxxxxxxxxxx
Delete review's comment: DELETE /api/reviews/{review_id}/comments/{comment_id}?apikey=xxxxxxxxxxxxxx

{
    "body": "Thanks for the kind review!",
    "author": "Joe Doe",
    "author_email": "joe@example.com",
    "author_slug": "joe-doe-29",
    "commented_at": "2016-01-02 10:00:00",
    "meta":
        {
            "created_in": "Germany"
        }
}