Aptoide - Web Services Documentation

Intro

About Aptoide Web Services

The objective of this Web Service is to allow applications to directly interact with Aptoide using REST.
In this documentation are described the current available functions of the Web Service.

Endpoints Overview

Endpoint	Description
app/getMeta	Get app meta data
apps/get	Get a list of apps
apps/search	Get a list of searched apps
comments/get	Get a list of comments
comment/set	Set a comment
comment/setVote	Set a comment vote
oauth2Authentication	Validate user credentials by returning an access token (to use in other webservices)
reviews/get	Get a list of reviews
review/set	Set a review
review/setVote	Set a review vote
store/getMeta	Get store meta data
store/set	Set store
store/groups/get	Get a list of store groups
store/group/getMeta	Get store group meta data
uploadAppToRepo	Upload an app to a user store

Authentication

Version	Format
V7 and V3	OAuth2 An access token may be required on some service requests. This token is generated through OAuth2, and a refresh token may be obtained through the same endpoint. See: co.aptoide.com/webservices/docs/3/oauth2Authentication
V2 and V1	Dev Token A Dev token (developer token) will be required on all service requests. This token is a 40 character string and is generated by the system when you sign up to use the Web Service. You can generate another token at any time, however there's only 1 token per developer. See: co.aptoide.com/webservices/docs/2/checkUserCredentials

Version

Format

V7 and V3

OAuth2

An access token may be required on some service requests.
This token is generated through OAuth2, and a refresh token may be obtained through the same endpoint.

See: co.aptoide.com/webservices/docs/3/oauth2Authentication

V2 and V1

Dev Token

A Dev token (developer token) will be required on all service requests.
This token is a 40 character string and is generated by the system when you sign up to use the Web Service.
You can generate another token at any time, however there's only 1 token per developer.

See: co.aptoide.com/webservices/docs/2/checkUserCredentials

Supported Formats

Version	Format
V7	Only JSON format is supported.
V3 and lower	XML and JSON formats are fully supported. The format may be specified in 2 ways: - Appending a "/extension" at the end of a URL when using the method GET: '/xml' or '/json'; - Passing a "mode" parameter through method POST: 'mode="xml"' or 'mode="json"'.

Error Handling

Errors are always returned within 'errors' with the respective messages generated by the service, while 'status' returns always either OK (success) or FAIL (failure), such as follows:

Version	Mode	Success	Failure
V7	JSON	{ "info":{ "status": "OK", "time": ... }, ... }	{ "info":{ "status": "FAIL", "time": ... }, "errors": [ { "code": ..., "description": ..., ... } ] }
V3 and lower	XML	<response> <status>OK</status> ... </response>	<response> <status>FAIL</status> <errors> <entry>Missing token parameter</entry> <entry>Missing repo parameter</entry> </errors> ... </response>
V3 and lower	JSON	{ "status":"OK", ... }	{ "status":"FAIL", "errors": [ "Missing token parameter", "Missing repo parameter" ] ... }