[Beta] Kudosi (formerly Ali Reviews) | Public APIs

This document provides all the information about Ali Reviews Public APIs. Our REST API lets you access to resources and perform actions on behalf of a shop.

On this Page

1. Authentication
2. List Reviews
3. Product Rating
4. Review Reaction
5. List Questions
6. Question Reaction

1. Authentication

Our API uses an API key to authenticate. You can get the API key of a shop from the App menu Integration → API key.
Bearer Token needs to be sent in the request header.

2. List Reviews

Method: GET
Endpoint URL: https://widget-hub-api.alireviews.io/api/public/reviews
Query params:
- product_id (int)(required)
- sort (string, values: [by_date, by_rating, by_content, by_media])(optional)
- direction (string, values: [asc, desc], default: desc)(optional)
- cursor (string)(optional)
Example:
- Request:

curl --location 'https://widget-hub-api.alireviews.io/api/public/reviews'

- Response:

{
    "status": true,
    "message": "Successfully.",
    "data": {
        "reviews": [
            {
                "id": 27921,
                "product_id": 7449246007545,
                "order_id": 0,
                "author": "Driscoll Dunlap",
                "star": 2,
                "content": "Non consectetur facilis corrupti molestiae dolore",
                "email": "neqakivuge@mailinator.com",
                "media": [],
                "total_likes": 0,
                "total_dislikes": 1,
                "created_at": "2023-03-22T16:57:28.000000Z",
                "updated_at": "2023-07-10T10:45:21.000000Z",
                "shop_id": 61173104889,
								"reply": "Thank you!"
            },
            {
                "id": 27900,
                "product_id": 7707800994041,
                "order_id": 0,
                "author": "A***a",
                "star": 5,
                "content": "wow very fast only 12 days to Indonesia, the product is really good easy to clean my Desktop thank you so much",
                "email": "",
                "media": [],
                "total_likes": 0,
                "total_dislikes": 0,
                "created_at": "2022-10-29T08:54:00.000000Z",
                "updated_at": "2022-11-01T00:25:24.000000Z",
                "shop_id": 61173104889,
								"reply": null
            },
            {
                "id": 27907,
                "product_id": 7707800994041,
                "order_id": 0,
                "author": "S***n",
                "star": 3,
                "content": "It can not 20000 pa. Never!",
                "email": "",
                "media": [],
                "total_likes": 0,
                "total_dislikes": 0,
                "created_at": "2022-10-23T04:42:00.000000Z",
                "updated_at": "2022-11-01T00:25:24.000000Z",
                "shop_id": 61173104889,
								"reply": null
            }
        ],
        "cursor": "eyJjcmVhdGVkX2F0IjoiMjAyMi0xMC0yMyAwNDo0MjowMCIsImlkIjoyNzkwNywiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    }
}

3. Product Rating

Method: GET
Endpoint URL: https://widget-hub-api.alireviews.io/api/public/products/rating
Query params:
- product_ids (string separator with comma)(required)
- with_details (boolean)(optional)
Example:
- Request:

> curl --location 'https://widget-hub-api.alireviews.io/api/public/products/rating?product_ids=7449246007545%2C7491766059257&with_details=1'

- Response:

{
    "status": true,
    "message": "Successfully.",
    "data": {
        "7449246007545": {
            "average_rating": 3.4,
            "total": 502,
            "details": [
                {
                    "star_rating": 1,
                    "total": 21
                },
                {
                    "star_rating": 2,
                    "total": 30
                },
                {
                    "star_rating": 3,
                    "total": 195
                },
                {
                    "star_rating": 4,
                    "total": 254
                },
                {
                    "star_rating": 5,
                    "total": 2
                }
            ]
        },
        "7491766059257": {
            "average_rating": 3.6,
            "total": 499,
            "details": [
                {
                    "star_rating": 1,
                    "total": 18
                },
                {
                    "star_rating": 2,
                    "total": 31
                },
                {
                    "star_rating": 3,
                    "total": 184
                },
                {
                    "star_rating": 4,
                    "total": 185
                },
                {
                    "star_rating": 5,
                    "total": 81
                }
            ]
        }
    }
}

4. Review Reaction

Method: PUT
Endpoint URL: https://widget-hub-api.alireviews.io/api/public/reviews/{{id}}/reactions
Query params:
- id (int)(required)
Payload:
- reaction (string, allowed values: like or dislike)(required)
Example:
- Request:

curl --location --request PUT 'https://widget-hub-api.alireviews.io/api/public/reviews/27898/reactions' \
--data '{
    "reaction": "like"
}'

- Response:

{
    "status": true,
    "message": "Successfully.",
    "data": {
        "id": 27898,
        "total_likes": 1,
        "total_dislikes": 0
    }
}

5. List Questions

Method: GET
Endpoint URL: https://widget-hub-api.alireviews.io/api/public/questions
Query params:
- product_id (int)(required)
- cursor (string)(optional)
Example:
- Request:

curl --location 'https://widget-hub-api-staging.alireviews.dev/api/public/questions'

- Response:

{
    "status": true,
    "message": "Successfully.",
    "data": {
        "questions": [
            {
                "id": 2,
                "shop_id": 61173104889,
                "product_id": 7449246007545,
                "customer_name": "Andree Lee",
                "customer_email": "andreelee836@gmail.com",
                "content": "Does this product work with Macbook Air?",
                "total_likes": 0,
                "total_dislikes": 0,
                "created_at": "2022-10-25T18:08:38.000000Z",
                "updated_at": "2022-10-25T18:11:43.000000Z",
                "reply": {
                    "id": 3,
                    "content": "thanks",
                    "total_likes": 0,
                    "total_dislikes": 0,
                    "created_at": "2023-05-12T00:00:00.000000Z",
                    "updated_at": "2023-05-12T00:00:00.000000Z"
                }
            },
            {
                "id": 1,
                "shop_id": 61173104889,
                "product_id": 7449246007545,
                "customer_name": "Samuel Arnold",
                "customer_email": "arnold.samuel@gmail.com",
                "content": "Can you ship this product to America?",
                "total_likes": 0,
                "total_dislikes": 0,
                "created_at": "2022-10-25T18:05:37.000000Z",
                "updated_at": "2023-07-11T09:54:56.000000Z",
                "reply": {
                    "id": 2,
                    "content": "thanks",
                    "total_likes": 1,
                    "total_dislikes": 0,
                    "created_at": "2023-05-12T00:00:00.000000Z",
                    "updated_at": "2023-07-11T09:19:32.000000Z"
                }
            }
        ],
        "cursor": null
    }
}

6. Question Reaction

Method: PUT
Endpoint URL: https://widget-hub-api.alireviews.io/api/public/questions/{{id}}/reactions
Query params:
- id (int)(required)
Payload:
- product_id (int)(required)
- type (string, allowed values: question or reply)(required)
- reaction (string, allowed values: like or dislike)(required)
Example:
- Request:

curl --location --request PUT 'https://widget-hub-api.alireviews.io/api/public/questions/1/reactions' \
--data '{
    "product_id": 7449246007545,
    "type": "question",
    "reaction": "like"
}'

Response:

{
    "status": true,
    "message": "Successfully.",
    "data": {
        "id": 1,
        "total_likes": 1,
        "total_dislikes": 0
    }
}

Or you can view this document here: https://ali-reviews.notion.site/Beta-Ali-Reviews-Public-APIs-67926f6757e54a928ebc64a78c33b7a8

Updated on: 27/08/2024