Aliexpress Open Platform

https://openservice.aliexpress.com/doc/
Admin
The Aliexpress Open Platform provides developers with APIs and tools to build applications,...
Tokens:14,768
Snippets:73
Trust Score:9.6
Update:2 days ago
Show doc for...
Tokens:
Raw
### Java example for generating signature and sending request

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.3d2259b2zcj79W#/?docId=1366

Step 7: Java code example that generates a signature using IopUtils.signApiRequest and sends a GET request using HttpUtils.sendGet. It uses placeholders for app key, secret, and code, and includes parameters for app_key, timestamp, sign_method, CODE, and simplify.

```java
public static void main(String[] args) throws Exception {

    final String SIGN_METHOD = "sha256";

    final String APP_KEY = "YOUR_APP_KEY";

    final String APP_SECRET = "YOUR_APP_SECRET";

    final String CODE = "YOUR_CODE";

    final String API_NAME = "/auth/token/create";

    long time = System.currentTimeMillis();

    String timeStamp = Long.toString(time);

    Map<String, String> params = new HashMap<String, String>();

    params.put("app_key", APP_KEY);

    params.put("timestamp", timeStamp);

    params.put("sign_method", "sha256");

    params.put("CODE", CODE);

    params.put("simplify", "true");

    String requestBody = null;

    String sign = IopUtils.signApiRequest(API_NAME,params, requestBody, APP_SECRET, SIGN_METHOD);

    params.put("sign",sign);

    String url = "https://api-sg.aliexpress.com/rest" + API_NAME + "?";

    for (String key : params.keySet()) {

        url += "&" + key + "=" + URLEncoder.encode(params.get(key), "utf-8");

    }

    System.out.println(url);

    String sendGet = HttpUtils.sendGet(url);

    System.out.println("sendGet = " + s
```

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

### GET/POST aliexpress.solution.product.schema.get

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.3d2259b2zcj79W#/?docId=1366

Example of assembling an HTTP request for the aliexpress.solution.product.schema.get API, including parameter sorting, signature generation, and final URL construction.

```APIDOC
## [GET/POST] aliexpress.solution.product.schema.get

### Description
This example demonstrates how to call the aliexpress.solution.product.schema.get API to get product schema. It shows the steps of assembling an HTTP request, including parameter population, sorting, signature generation, and final URL construction.

### Method
GET/POST

### Endpoint
https://api-sg.aliexpress.com/sync?method={api_path}&{query}

### Parameters
#### Common Parameters
- **app_key** (string) - Required - The application key assigned to your app.
- **access_token** (string) - Required - The access token for the authorized seller.
- **timestamp** (string) - Required - The timestamp of the request in milliseconds.
- **sign_method** (string) - Required - The signature method, e.g., "sha256".

#### Business Parameters
- **aliexpress_category_id** (string) - Required - The category ID for which to get the product schema.
- **method** (string) - Required - The API method name, e.g., "aliexpress.solution.product.schema.get".

### Request Example
```
https://api-sg.aliexpress.com/sync?method=aliexpress.solution.product.schema.get&app_key=12345678&aliexpress_category_id=200135143&access_token=test&timestamp=1517820392000&sign_method=sha256&sign=F7F7926B67316C9D1E8E15F7E66940ED3059B1638C497D77973F30046EFB5BBB
```

### Signature Generation
1. Sort all parameters and values according to the parameter name in ASCII table.
2. Concatenate the sorted parameters and their values into a string.
3. Generate the signature using the App Secret with the SHA256 algorithm.

Example signature string:
```
access_tokentestaliexpress_category_id200135143app_key123456methodaliexpress.logistics.redefining.getonlinelogisticsinfosign_methodsha256timestamp1517820392000
```

Signature result:
```
F7F7926B67316C9D1E8E15F7E66940ED3059B1638C497D77973F30046EFB5BBB
```

### Response
No response details are provided in the source documentation.
```

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

### Example of api_path key value pair sorting

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.628459b2pdm9Xj#/?docId=1367

Shows an example of sorting request parameters by name in ASCII order. The comment notes the method is aliexpress.offer.product.post. Before sort: foo=1, bar=2, foo_bar=3, foobar=4. After sort: bar=2, foo=1, foo_bar=3, foobar=4.

```plaintext
// Example of api_path key value pair

// method : aliexpress.offer.product.post

Before sort: foo=1, bar=2, foo_bar=3, foobar=4

After sort: bar=2, foo=1, foo_bar=3, foobar=4
```

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

### Hexadecimal conversion example

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.628459b2pdm9Xj#/?docId=1367

Shows converting a UTF-8 encoded string to hexadecimal format. Example: hex("helloworld".getBytes("utf-8")) = "68656C6C6F776F726C64".

```plaintext
hex("helloworld".getBytes("utf-8")) = "68656C6C6F776F726C64"
```

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

### Java SDK example for /auth/token/create

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.71ae59b2MxkAsD#/?docId=1364

Java code using the IopClient SDK to call the /auth/token/create API. Replace 'your_appkey', 'your_appSecret', and 'your_code' with actual values. The response is printed as JSON and as the GOP response body.

```Java
public static void main(String[] args) {

    String url = "https://api-sg.aliexpress.com";
    String appkey = "your_appkey";
    String appSecret = "your_appSecret";
    String action = "/auth/token/create";

    IopClient client = new IopClientImpl(url, appkey, appSecret);
    IopRequest request = new IopRequest();
    request.setApiName(action);
    request.addApiParameter("code", "your_code");

    try {
        IopResponse response = client.execute(request, Protocol.GOP);
        System.out.println(JSON.toJSON(response));
        System.out.println(response.getGopResponseBody());
    } catch (Exception e) {
        e.printStackTrace();
    }
}
```

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

### Java example for generateToken API call

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

Java code snippet using IopClient to call the /auth/token/create endpoint with code and uuid parameters. The response is printed to the console.

```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);
```

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

### Adding API name for System Interface

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.628459b2pdm9Xj#/?docId=1367

For System Interfaces, the API name (e.g., /test/api) is prepended to the concatenated string. This example shows the resulting string.

```plaintext
/test/apibar2foo1foo_bar3foobar4
```

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

### Generate signature using SHA256

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.3d2259b2zcj79W#/?docId=1366

Step 5: Generate the signature by applying SHA256 to the string from Step 4 and converting to hexadecimal. The example uses App Secret 'helloworld' and shows the resulting signature.

```plaintext
hex(sha256(/auth/token/createapp_key12345678code3_500102_JxZ05Ux3cnnSSUm6dCxYg6Q26sign_methodsha256timestamp1517820392000))=35607762342831B6A417A0DED84B79C05FEFBF116969C48AD6DC00279A9F4D81
```

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

### Sample token response

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.71ae59b2MxkAsD#/?docId=1364

Example JSON response containing access_token, refresh_token, and related fields. The tokens are for reference only; for ISVs migrated from the original open platform, the 'user_id' corresponds to 'havana_id'.

```JSON
{
    "refresh_token_valid_time": 4804563378176,
    "havana_id": "17379911544",
    "expire_time": 4804563378176,
    "locale": "zh_CN",
    "user_nick": "test1234",
    "access_token": "50000000528VP2cqMgQ9h1pUf85GuepqZzuGae1891407feu3qVtfglCKlIW",
    "refresh_token": "50001001928fJIbsqf6eaUuYiFkuhxlrsHiaCr116e71adsfJuZpon3oieGw",
    "user_id": "200042362",
    "account_platform": "seller_center",
    "refresh_expires_in": 3153599922,
    "expires_in": 3153599922,
    "sp": "ae",
    "seller_id": "200042362",
    "account": "test1234@126.com",
    "code": "0",
    "request_id": "212a77bf16509634562801070"
}
```

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

### Sample JSON response for generateToken

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

Example JSON response returned by the generateToken API, containing token details such as access_token, refresh_token, and expiration times.

```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"
}
```

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

### HMAC_SHA256 digest example

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.628459b2pdm9Xj#/?docId=1367

Shows the HMAC_SHA256 digest operation applied to the concatenated string with the API name.

```plaintext
hmac_sha256(/test/apibar2foo1foo_bar3foobar4)
```

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

### Add API name in front of concatenated string

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.3d2259b2zcj79W#/?docId=1366

Step 4: Add the API name '/auth/token/create' in front of the concatenated string from Step 3.

```plaintext
/auth/token/createapp_key12345678code3_500102_JxZ05Ux3cnnSSUm6dCxYg6Q26sign_methodsha256timestamp1517820392000
```

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

### Java sample code for signing API requests

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.628459b2pdm9Xj#/?docId=1367

Provides a complete Java implementation for signing API requests. It sorts parameters, appends the API name for system interfaces, and uses HMAC-SHA256 to generate the signature. The code includes helper methods for encryption and hex conversion.

```java
public static final String CHARSET_UTF8 = "UTF-8";

public static final String SIGN_METHOD_SHA256 = "sha256";

public static final String SIGN_METHOD_HMAC_SHA256 = "HmacSHA256";

public static String signApiRequest(Map<String, String> params, String appSecret, String signMethod, String apiName) throws IOException {

// If you are using Business Interface, please do as step 1,add api_path into params.

// params.put("method",apiName);

// sort all text parameters

String[] keys = params.keySet().toArray(new String[0]);

Arrays.sort(keys);

// connect all text parameters with key and value

StringBuilder query = new StringBuilder();

// If you are using System Interface, please do as step 3

// append API name

query.append(apiName);

for (String key : keys) {

String value = params.get(key);

if (areNotEmpty(key, value)) {

query.append(key).append(value);

}

}

// sign the whole request

byte[] bytes = null;

if (signMethod.equals(SIGN_METHOD_SHA256)) {

bytes = encryptHMACSHA256(query.toString(), appSecret);

}

// finally : transfer sign result from binary to upper hex string

return byte2hex(bytes);

}

private static byte[] encryptHMACSHA256(String data, String secret) throws IOException {

byte[] bytes = null;

try {

SecretKey secretKey = new SecretKeySpec(secret.getBytes(CHARSET_UTF8), SIGN_METHOD_HMAC_SHA256);

Mac mac = Mac.getInstance(secretKey.getAlgorithm());

mac.init(secretKey);

bytes = mac.doFinal(data.getBytes(CHARSET_UTF8));

} catch (GeneralSecurityException gse) {

throw new IOException(gse.toString());

}

return bytes;

}

/**

* Transfer binary array to HEX string.

*/

public static String byte2hex(byte[] bytes) {

StringBuilder sign = new StringBuilder();

for (int i = 0; i < bytes.length; i++) {

String hex = Integer.toHexString(bytes[i] & 0xFF);

if (hex.length() == 1) {

sign.append("0");

}

sign.append(hex.toUpperCase());

}

return
```

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

### GET/POST /auth/token/create

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

Generates an access token for calling AliExpress APIs. Requires an OAuth code from the app callback URL and an optional UUID.

```APIDOC
## [GET/POST] /auth/token/create

### Description
Generates access_token for call api

### Method
GET/POST

### Endpoint
/auth/token/create

### Parameters
#### Query Parameters
- **code** (String) - Required - oauth code, get from app callback URL
- **uuid** (String) - Optional - 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 th refresh token
- **expire_time** (Number) - expire time
- **refresh_token_valid_time** (Number) - refresh token valid time
- **sp** (String) - sp
- **locale** (String) - locale

#### Response Example
{
  "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
- **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.

### Request Example
```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);
```
```

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

### Assemble HTTP request URL

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.3d2259b2zcj79W#/?docId=1366

Step 6: Assemble the HTTP request URL by encoding all parameters and values (including 'sign') in UTF-8 and appending them as a query string to the base URL 'https://api-sg.aliexpress.com/rest{api_path}?{query}'.

```plaintext
https://api-sg.aliexpress.com/rest/auth/token/create?app_key=12345678&code=3_500102_JxZ05Ux3cnnSSUm6dCxYg6Q26&timestamp=1517820392000&sign_method=sha256&sign=35607762342831B6A417A0DED84B79C05FEFBF116969C48AD6DC00279A9F4D81
```

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

### GET/POST /auth/token/create

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.3d2259b2zcj79W#/?docId=1366

Generates an access token. This API is used to obtain an access token using an authorization code. The request must be signed with the app secret.

```APIDOC
## [GET/POST] /auth/token/create

### Description
Generates an access token. This API is used to obtain an access token using an authorization code. The request must be signed with the app secret.

### Method
GET/POST

### Endpoint
https://api-sg.aliexpress.com/rest/auth/token/create

### Parameters
#### Query Parameters
- **app_key** (string) - Required - The application key.
- **timestamp** (string) - Required - The current timestamp in milliseconds.
- **sign_method** (string) - Required - The signature method, e.g., "sha256".
- **code** (string) - Required - The authorization code.
- **sign** (string) - Required - The generated signature.

### Request Example
https://api-sg.aliexpress.com/rest/auth/token/create?app_key=12345678&code=3_500102_JxZ05Ux3cnnSSUm6dCxYg6Q26&timestamp=1517820392000&sign_method=sha256&sign=35607762342831B6A417A0DED84B79C05FEFBF116969C48AD6DC00279A9F4D81

### Response
#### Success Response (200)
- **access_token** (string) - The generated access token.

#### Response Example
{
  "access_token": "your_access_token"
}

### Notes
- All parameters must be encoded in UTF-8.
- The signature is generated by concatenating the API path and sorted parameters, then applying HMAC-SHA256 with the app secret.
- If the URL length is less than 1024 characters, GET can be used; otherwise, POST must be used.
```

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

### System API Endpoint

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.628459b2pdm9Xj#/?docId=1369

Endpoint for system APIs on the AliExpress Open Platform. Use this endpoint for authorization-related APIs under 'System Tool'.

```APIDOC
## [GET] https://api-sg.aliexpress.com/rest{api_path}?{query}

### Description
Endpoint for system APIs on the AliExpress Open Platform. Use this endpoint for authorization-related APIs under 'System Tool'.

### Method
GET

### Endpoint
https://api-sg.aliexpress.com/rest{api_path}?{query}

### Parameters
#### Query Parameters
- **{api_path}** (string) - Required - The path of the specific API.
- **{query}** - Required - The calling parameters for the API.

### Notes
- {api_path} means the path of the specific API.
- {query} means the calling parameters.
```

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

### generateToken

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

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

```APIDOC
## [GET/POST] /auth/token/create

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

### Method
GET/POST

### Endpoint
/auth/token/create

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

### Request Example
```
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);
```

### 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. |
```

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

### Assemble HTTP request URL

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.628459b2pdm9Xj#/?docId=1366

This is the final HTTP request URL after encoding all parameters and values with the 'sign' parameter. The splicing method is https://api-sg.aliexpress.com/sync?method={api_path}&{query}.

```plaintext
https://api-sg.aliexpress.com/sync?method=aliexpress.solution.product.schema.get&app\_key=12345678&aliexpress\_category\_id=200135143&access\_token=test&timestamp=1517820392000&sign\_method=sha256&sign=F7F7926B67316C9D1E8E15F7E66940ED3059B1638C497D77973F30046EFB5BBB
```

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

### Business API Endpoint

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.628459b2pdm9Xj#/?docId=1369

Endpoint for business APIs on the AliExpress Open Platform. Use this endpoint for all APIs except system APIs.

```APIDOC
## [GET] https://api-sg.aliexpress.com/sync?method={api_path}&{query}

### Description
Endpoint for business APIs on the AliExpress Open Platform. Use this endpoint for all APIs except system APIs.

### Method
GET

### Endpoint
https://api-sg.aliexpress.com/sync?method={api_path}&{query}

### Parameters
#### Query Parameters
- **method** (string) - Required - The path of the specific API.
- **{query}** - Required - The calling parameters for the API.

### Notes
- {api_path} means the path of the specific API.
- {query} means the calling parameters.
```

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

### Concatenated sorted parameters string

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.628459b2pdm9Xj#/?docId=1367

Shows the result of concatenating sorted parameters and their values into a single string: bar2foo1foo_bar3foobar4.

```plaintext
bar2foo1foo_bar3foobar4
```

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

### Concatenate sorted parameters into a string

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.3d2259b2zcj79W#/?docId=1366

Step 3: Concatenate the sorted parameters and their values into a single string. The string is formed by appending each parameter name and value without any separators.

```plaintext
app_key12345678code3_500102_JxZ05Ux3cnnSSUm6dCxYg6Q26sign_methodsha256timestamp1517820392000
```

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

### POST /auth/token/refresh

Source: https://openservice.aliexpress.com/doc/doc.htm?docId=118729&nodeId=27493&spm=a2o9m.11193535.0.0.71ae59b2MxkAsD#/?docId=1364

Refreshes the access token using the current refresh token. Returns new access_token and refresh_token. The access token duration resets, but the refresh token duration does not. The refresh token must be saved for future refreshes.

```APIDOC
## POST /auth/token/refresh

### Description
Refreshes the access token using the current refresh token. Returns new access_token and refresh_token. The access token duration resets, but the refresh token duration does not. The refresh token must be saved for future refreshes.

### Method
POST

### Endpoint
/auth/token/refresh

### Response
#### Success Response
- **access_token** (string) - New access token.
- **refresh_token** (string) - New refresh token. Must be saved for future refreshes.
- **refresh_expires_in** (integer) - Time in seconds until the refresh token expires. If 0, the access token cannot be refreshed.

#### Response Example
{
  "access_token": "new_access_token",
  "refresh_token": "new_refresh_token",
  "refresh_expires_in": 3600
}

### Usage Notes
- Sellers do not need to authorize again before the token expires.
- If refresh_expires_in = 0, the access token cannot be refreshed. Only when refresh_expires_in > 0, you can call this API.
- It is recommended to refresh the token 30 minutes before it expires.
```
Tokens:
Raw