New user?
REGISTER NOW!

Returning user?
SIGN IN!


Forgot your password?


It's completely free!

OR

ANDROID DEV
Register here

Forgot your password?


Loading...
OR

You're one step closer to becoming a Aptoider!

We will send you a confirmation email to

In the meantime please continue to the final registration step.


Continue to final step Ups... wrong email...

Need to contact us?

Please insert an email address Password must:<br>- have 8 characters minimum<br>- have one letter<br>- have one number OR one special character (!@#$%*) This url is invalid, please enter an valid one. Use only letters, numbers and/or dashes. No spaces please! Please insert a name Business Name should be smaller than 40 characters. Please insert an address. Please insert an company name. Please insert an valid country. Please insert a valid phone number. Please insert a valid phone number. Please insert an city. Please insert an zip/postal code. Please insert an tax ID / VAT. You must agree with terms of use. You must select one option RETRY JOIN NOW https://www.aptoide.com/phpajax/onboarding.php
This website uses cookies to improve service quality. By browsing this website, you are consenting the use of cookies.
I understand Learn more
OK

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: www.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: www.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>

JSON
{
   "status":"OK",
   ...
}


{
   "status":"FAIL",
   "errors":
      [
         "Missing token parameter",
         "Missing repo parameter"
      ]
   ...
}