Aptoide - Web Services Documentation

listReviews

URLS:

GET

https://ws2.aptoide.com/api/7/reviews/get

https://ws2.aptoide.com/api/7/listReviews

Supported Formats:

JSON

Supported Methods:

GET

Description:

Get a list of reviews

Arguments:

Name

Description

Input

Details

apk_id

Apk file ID.

+INT31

Default:	null
Example:	2422529

apk_md5sum

Apk file md5sum.

HEXADECIMAL

Default:	null
Properties:	• Length: 32
Example:	"aefde962dae50881d4353089fa8039f1"

app_id

Application ID.

+INT31

Default:	null
Example:	7306243

cdn

CDN type selector.

STRING

Default:	"pool"
Properties:	• Allowed values: "pool", "web", "apw"
Example:	"web"

info

Show API info page.

BOOLEAN

Default:	false
Example:	true

language

Language.

STRING

Default:	"en"
Properties:	• Min length: 2 • Max length: 6
Example:	"pt_PT"

languages_filter_sort

Languages filter sort.

STRING

Default:	null
Example:	"pt_PT,en_GB"

limit

Lists items limit.

+INT31_NULL

Default:	25
Example:	15

offset

Lists items offset.

UINT32

Default:	0
Example:	5

order

List order direction.

STRING

Default:	null
Properties:	• Allowed values: "ASC", "DESC" • Upper case
Example:	"ASC"

package_id

Apk package ID.

+INT31

Default:	null
Example:	240

package_name

Apk package name.

PACKAGE_NAME

Default:	null
Example:	"cm.aptoide.pt"

refresh

Refresh request.

BOOLEAN

Default:	false
Example:	true

review_groups

Review groups.

LIST

Default:	[]
Properties:	• Max length: 3• Input (STRING): › Allowed values: "store_owner", "others", "highlighted"
Example:	["owner"]

review_type

Review type.

STRING

Default:	"STORE_PACKAGE"
Properties:	• Allowed values: "STORE_PACKAGE"
Example:	"STORE_PACKAGE"

sort

List sort type.

STRING

Default:	"latest"
Properties:	• Allowed values: "latest", "points", "rating"
Example:	"points"

store_id

Store ID.

+INT31

Default:	null
Example:	15

store_name

Store name.

DOMAIN_LABEL

Default:	null
Example:	"apps"

store_pass_sha1

Store private password SHA1.

HEXADECIMAL

Default:	null
Properties:	• Length: 40
Example:	"85136c79cbf9fe36bb9d05d0639c70c265c18d37"

store_user

Store private username.

STRING

Default:	null
Properties:	• Max length: 128
Example:	"aptuser1000"

sub_limit

Lists items sub limit

+INT31_NULL

Default:	null
Example:	15

tag_name

Tag name.

DOMAIN_LABEL

Default:	null
Example:	"community"

tag_type

Tag type.

STRING

Default:	null
Example:	"custom"

view

View mode of internal responses.

STRING

Default:	"url"
Properties:	• Allowed values: "url", "response"
Example:	"response"

Mandatory arguments:

This endpoint requires 1 of the following possible combinations of arguments:

• app_id

• apk_id

• apk_md5sum

• package_id

• package_name

• store_id

• store_name

• tag_name AND tag_type

Arguments Aliases:

This endpoint has the following possible arguments aliases:

• language : lang

• view : nview

Inputs:

Name	Description	Examples
+INT31	31 bits positive integer: 1 to 2147483647	• 1 • 5024 • 70733
+INT31_NULL	31 bits positive nullable integer: 0 to 2147483647 (0 = NULL)	• 0 • 5024 • 70733
BOOLEAN	Boolean: FALSE (0, f, false, no, off) or TRUE (1, t, true, yes, on)	• 0 • 1 • true • "f"
DOMAIN_LABEL	Web domain label	• "site" • "my-domain-label" • "some-other-domain-label"
HEXADECIMAL	String of hexadecimal characters	• "e602a3" • "ff406b8c63e96a963ce592" • "8843d7f92416211de9ebb963ff4ce28125932878"
LIST	List of items as: String of characters	• "a,foobar,Some text" • ["a", "foobar", "Some text"]
PACKAGE_NAME	Java package name	• "com.package.vendor" • "cm.aptoide.pt" • "com.android.package.sub.foobar"
STRING	String of characters	• "a" • "foobar" • "Some text"
UINT32	32 bits unsigned integer: 0 to 4294967295	• 0 • 5024 • 60422124

Response:

• application/json

Error Codes:

Name	Description	Http Code
API-1	Invalid value ... for argument '...'	400 Bad Request
API-2	Invalid output '...'	400 Bad Request
API-3	Missing mandatory arguments '...'	400 Bad Request
API-4	At least 1 node must be set	400 Bad Request
API-5	Malformed node at ...	400 Bad Request
API-6	Invalid node '...'	400 Bad Request
API-7	Missing mandatory arguments '...' for condition '...'	400 Bad Request
APP-1	Application '...' not found	404 Not Found
APP-2	Application '...' is pending approval	403 Forbidden
APP-3	Application '...' is private: authentication required	401 Unauthorized
APP-4	Application '...' is private: authentication failed (invalid '...')	401 Unauthorized
APP-5	Application '...' is private: access denied	403 Forbidden
APP-6	Application '...' is not available	410 Gone
APP-7	Application '...' was suspended	410 Gone
APP-8	Application '...' was removed	410 Gone
APP-9	Application '...' is infected	410 Gone
APP-10	Application '...' is not available in your country	403 Forbidden
APP-11	Application '...' is currently being deleted	410 Gone
APP-12	Application '...' was deleted	410 Gone
AUTH-1	Authentication required	401 Unauthorized
AUTH-2	Authentication failed: invalid '...'	401 Unauthorized
AUTH-3	Authentication failed: expired '...'	401 Unauthorized
AUTH-4	Authentication error	500 Internal Server Error
AUTH-5	Access denied: access level ... required	403 Forbidden
AUTH-6	Access denied: not in allowed groups	403 Forbidden
AUTH-7	Access denied: not in allowed countries	403 Forbidden
AUTH-8	Access denied: not in allowed IP addresses	403 Forbidden
AUTH-9	Access denied: not in allowed domains	403 Forbidden
AUTH-10	Access denied: not in allowed origins (CORS)	403 Forbidden
AUTH-11	Access denied: unauthorized user	403 Forbidden
AUTH-12	Access denied: unauthorized operation	403 Forbidden
COMMENT-1	Comment '...' not found	404 Not Found
COMMENT-2	Operation not allowed for comment	403 Forbidden
REVIEW-1	Review '...' not found	404 Not Found
REVIEW-2	Operation not allowed for review	403 Forbidden
STORE-1	Store '...' not found	404 Not Found
STORE-2	Store '...' is pending approval	403 Forbidden
STORE-3	Store '...' is private: authentication required	401 Unauthorized
STORE-4	Store '...' is private: authentication failed (invalid '...')	401 Unauthorized
STORE-5	Store '...' is private: access denied	403 Forbidden
STORE-6	Store '...' was closed	403 Forbidden
STORE-7	Store '...' was suspended	410 Gone
SYS-0	(╯°□°）╯︵ ┻━┻	417 Expectation Failed
SYS-1	An unknown system error occurred, please try again	500 Internal Server Error
SYS-2	The system is down for maintenance, please try again later	503 Service Unavailable
USER-0	User not specified	400 Bad Request
USER-1	User '...' not found	404 Not Found
USER-2	User '...' is pending approval	403 Forbidden
USER-3	User '...' is private: authentication required	401 Unauthorized
USER-4	User '...' is private: access denied	403 Forbidden
USER-5	User '...' was suspended	410 Gone

Sample Request URL:

https://ws2.aptoide.com/api/7/reviews/get/package_name=cm.aptoide.pt/store_name=apps/limit=3

Sample Response (json):

{
   "info": {
      "status": "OK",
      "time": {
         "seconds": 0.019908905029297,
         "human": "19 milliseconds"
      }
   },
   "datalist": {
      "total": 756,
      "count": 3,
      "offset": 0,
      "limit": 3,
      "next": 3,
      "hidden": 0,
      "loaded": true,
      "list": [
         {
            "id": 2684800,
            "title": "#1",
            "body": null,
            "intro": null,
            "outro": null,
            "added": "2017-05-29 04:26:09",
            "modified": "2017-05-29 04:26:09",
            "user": {
               "id": 12064722,
               "name": "erikiki",
               "avatar": "http://pool.img.aptoide.com/apps/e648fe9460e77298fe382dce82083045_avatar.png"
            },
            "items": [],
            "stats": {
               "rating": 5,
               "points": 0
            },
            "comments": {
               "total": 0,
               "view": "https://ws2.aptoide.com/api/7/listComments/review_id=2684800/limit=1/sort=latest/order=desc"
            },
            "data": null
         },
         {
            "id": 2682928,
            "title": "ok",
            "body": null,
            "intro": null,
            "outro": null,
            "added": "2017-05-28 17:59:48",
            "modified": "2017-05-28 17:59:48",
            "user": {
               "id": 13105756,
               "name": "Mohd Fitri Jojo",
               "avatar": "http://pool.img.aptoide.com/apps/4dfdf8c56367926cb5cf1539f878c355_avatar.png"
            },
            "items": [],
            "stats": {
               "rating": 5,
               "points": 0
            },
            "comments": {
               "total": 0,
               "view": "https://ws2.aptoide.com/api/7/listComments/review_id=2682928/limit=1/sort=latest/order=desc"
            },
            "data": null
         },
         {
            "id": 2682301,
            "title": "bom",
            "body": null,
            "intro": null,
            "outro": null,
            "added": "2017-05-28 15:32:43",
            "modified": "2017-05-28 15:32:43",
            "user": {
               "id": 13063614,
               "name": "Arcanjo Lima",
               "avatar": "http://pool.img.aptoide.com/apps/4dfecf2b5ccac1e9ce2cead8ea23ea2a_avatar.png"
            },
            "items": [],
            "stats": {
               "rating": 5,
               "points": 0
            },
            "comments": {
               "total": 0,
               "view": "https://ws2.aptoide.com/api/7/listComments/review_id=2682301/limit=1/sort=latest/order=desc"
            },
            "data": null
         }
      ]
   }
}