AliExpress OpenService API

https://openservice.aliexpress.com/doc/api.htm
Admin
AliExpress OpenService API provides comprehensive REST endpoints for sellers and developers to...
Tokens:2,121
Snippets:7
Trust Score:9.6
Update:1 day ago
Show doc for...
Tokens:
Raw
### JAVA example for /auth/token/create

Source: https://openservice.aliexpress.com/doc/api.htm#/api?cid=3&path=/auth/token/create&methodType=GET/POST

Example of calling the generateToken API using the IopClient in JAVA. It sets the API name to /auth/token/create and adds the code and uuid parameters, then executes the request and prints the response body.

```JAVA
IopClient client = new IopClient(url, appkey, appSecret);
IopRequest request = new IopRequest();
request.setApiName("/auth/token/create");
request.addApiParameter("code", "0_2DL4DV3jcU1UOT7WGI1A4rY91");
request.addApiParameter("uuid", "uuid");
IopResponse response = client.execute(request, Protocol.GOP);
System.out.println(response.getBody());
Thread.sleep(10);
```

--------------------------------

### Streamlined Return JSON response for /auth/token/create

Source: https://openservice.aliexpress.com/doc/api.htm#/api?cid=3&path=/auth/token/create&methodType=GET/POST

Example JSON response from the generateToken API, showing the returned fields such as access_token, refresh_token, expires_in, and account details.

```json
{
  "refresh_token_valid_time": "1437129035362",
  "havana_id": "1001",
  "code": "0",
  "expire_time": "1437129035362",
  "locale": "zh_CN",
  "user_nick": "nick",
  "access_token": "50000601c30atpedfgu3LVvik87Ixlsvle3mSoB7701ceb156fPunYZ43GBg",
  "refresh_token": "500016000300bwa2WteaQyfwBMnPxurcA0mXGhQdTt18356663CfcDTYpWoi",
  "account_id": "7063844",
  "user_id": "1001",
  "account_platform": "seller_center",
  "refresh_expires_in": "60",
  "expires_in": "10",
  "sp": "ae",
  "request_id": "0ba2887315178178017221014",
  "seller_id": "1001",
  "account": "xxx@gmail.com"
}
```

--------------------------------

### POST /auth/token/create

Source: https://openservice.aliexpress.com/doc/api.htm#/api?cid=3&path=/auth/token/create&methodType=GET/POST

Generates an access token for calling AliExpress Open Platform APIs. Requires an OAuth code obtained from the app callback URL.

```APIDOC
## POST /auth/token/create

### Description
Generates an access token for calling AliExpress Open Platform APIs. Requires an OAuth code obtained from the app callback URL.

### Method
POST

### Endpoint
/auth/token/create

### Parameters
#### Request Body
- **code** (String) - Required - OAuth code, get from app callback URL.
- **uuid** (String) - Optional - UUID.

### Request Example
```json
{
  "code": "0_2DL4DV3jcU1UOT7WGI1A4rY91",
  "uuid": "uuid"
}
```

### Response
#### Success Response (200)
- **expires_in** (Number) - The expiring time of the access token, in seconds.
- **account_id** (String) - Account ID, allow null. If account_platform=seller_center, account_id=null.
- **seller_id** (String) - Seller ID.
- **user_id** (String) - User ID.
- **user_nick** (String) - Nick.
- **havana_id** (String) - Havana ID.
- **account_platform** (String) - Account platform.
- **access_token** (String) - Access token.
- **account** (String) - User account (login user).
- **refresh_token** (String) - Refresh token, used to refresh the token when refresh_expires_in > 0.
- **refresh_expires_in** (Number) - The expiring time of the refresh token.
- **expire_time** (Number) - Expire time.
- **refresh_token_valid_time** (Number) - Refresh token valid time.
- **sp** (String) - SP.
- **locale** (String) - Locale.

#### Response Example
```json
{
  "refresh_token_valid_time": "1437129035362",
  "havana_id": "1001",
  "code": "0",
  "expire_time": "1437129035362",
  "locale": "zh_CN",
  "user_nick": "nick",
  "access_token": "50000601c30atpedfgu3LVvik87Ixlsvle3mSoB7701ceb156fPunYZ43GBg",
  "refresh_token": "500016000300bwa2WteaQyfwBMnPxurcA0mXGhQdTt18356663CfcDTYpWoi",
  "account_id": "7063844",
  "user_id": "1001",
  "account_platform": "seller_center",
  "refresh_expires_in": "60",
  "expires_in": "10",
  "sp": "ae",
  "request_id": "0ba2887315178178017221014",
  "seller_id": "1001",
  "account": "xxx@gmail.com"
}
```

### Error Codes
| Error code | Error message | Solution |
| --- | --- | --- |
| AUTH_TYPE_UNSUPPORTED | Authorization type not supported | The authorization type is not supported. Please check the authorization type. |
| InvalidAppkey | Invalid Appkey | Appkey is invalid, please check the appkey. |
| ServiceUnavailable | Service Unavailable | Service unavailable, please contact the developer. |
| IncompleteSignature | The request signature does not conform to platform standards | The request sign generated by the signature algorithm does not comply with the platform specifications. Please refer to the signature algorithm documentation and compare the test data provided in the documentation one by one to check if your own signature algorithm is correct. |
| InvalidCode | Invalid Code | The following possible reasons can be self checked: 1. The code has expired. The current validity period of the code is three minutes. If it is not consumed after the timeout, the code will expire. 2. The uuid parameter has been set, which is an invalid parameter and can cause this error. Please do not set it to pass, as this parameter will be optimized in the subsequent interface documentation. 3. Repeated consumption of code. You can use the logging tool in the console to query the consumption status of the code (search for keywords based on code). If the code has already been successfully called and consumed, calling the authorization interface again will report this error. 4. Invalid code, not obtained through the authorization document link mentioned above. |
```
Tokens:
Raw