AliExpress Open Service

https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590
Admin
AliExpress Open Service provides a comprehensive developer guide for integrating applications,...
Tokens:3,675
Snippets:25
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Java Access Token Exchange

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

Example implementation for exchanging an authorization code for an access token using the IopClient in Java.

```java
public static void main(String[] args) {
// Appkey of the application.
String url = "https://api-sg.aliexpress.com";
String appkey = "your_appkey";
// AppSecret of the application.
String appSecret = "your_appSecret";
// Requested API interface name.
String action = "/auth/token/create";
  
// Create an IopClient object and pass in the API address, appkey and appSecret
IopClient client = new IopClientImpl(url, appkey, appSecret);
  
// Create an IopRequest object and pass in the API interface name and parameters
IopRequest request = new IopRequest();
request.setApiName(action);
request.addApiParameter("code", "your_code");
  
try {
// Perform API requests, using the GOP protocol
IopResponse response = client.execute(request, Protocol.GOP);
  
// Output the JSON string of the request response result
System.out.println(JSON.toJSON(response));
  
// Output the GOP format string of the request response result
System.out.println(response.getGopResponseBody());
} catch (Exception e) {
// Catch exception and print stack information
e.printStackTrace();
}
}
```

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

### GET /oauth/authorize

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

Redirects the user to the AliExpress authorization page to grant permissions to the application.

```APIDOC
## GET /oauth/authorize

### Description
Redirects the user to the AliExpress authorization page. The user logs in and grants permissions, after which they are redirected to the specified callback URL with a temporary code.

### Endpoint
https://api-sg.aliexpress.com/oauth/authorize

### Query Parameters
- **response_type** (string) - Required - Must be set to 'code'.
- **force_auth** (boolean) - Required - Set to 'true' to force the login panel.
- **redirect_uri** (string) - Required - The callback URL where the user is redirected after authorization.
- **client_id** (string) - Required - The application's appkey.
```

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

### Token Refresh Response Structure

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

Example of the JSON response returned by the /auth/token/refresh interface.

```JSON
{
"refresh_token_valid_time":1716784148000,
"havana_id":"3000021188814",
"expire_time":1714192160000,
"locale":"zh_CN",
"user_nick":"kr10404958150000",
"access_token":"",
"refresh_token":" ",
"user_id":"2637908814",
"account_platform":"buyerApp",
"refresh_expires_in":5183988,
"expires_in":2592000,
"sp":"ae",
"seller_id":"2637908814",
"account":"ae_test_u0000@163.com",
"code":"0",
"request_id":"212a69f317116001605067741"
}
```

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

### PHP Access Token Exchange

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

Example implementation for exchanging an authorization code for an access token in PHP. Note that system-level APIs require the specific URL https://api-sg.aliexpress.com/rest.

```php
<?php
// API request address
$url = "https://api-sg.aliexpress.com/rest";
// For system-level request addresses, you need to use the above URL
// appkey of the application
$appkey = "your_appkey";
// appSecret of the application
$appSecret = "your_appSecret";
// Requested API interface name
$action = "/auth/token/create";
  
// Create an IopClient object and pass in the API address, appkey and appSecret
$client = new IopClientImpl($url, $appkey, $appSecret);
  
// Create an IopRequest object and pass in the API interface name and parameters
$request = new IopRequest();
$request->setApiName($action);
$request->addApiParameter("code", "your_code");
  
try {
// Execute API request, using GOP protocol
$response = $client->execute($request, Protocol::GOP);
  
// Output the JSON string of the request response result
echo json_encode($response);
  
// Output the GOP format string of the request response result
echo $response->getGopResponseBody();
} catch (Exception $e) {
// Catch exception and print stack information
echo $e->getMessage();
}
```

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

### Refresh Token in Java

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

Demonstrates how to use the IopClient to refresh an access token in Java.

```Java
public class MainClass {
public static void main(String[] args) {
// Initialize the client with the API URL, app key, and app secret
String url = "https://api-sg.aliexpress.com";
String appkey = "your_appkey";
String appSecret = "your_appSecret";
IopClient client = new IopClient(url, appkey, appSecret);
  
// Create a new request and set the API name and parameters
IopRequest request = new IopRequest();
request.setApiName("/auth/token/refresh");
request.addApiParameter("refresh_token", "Your-Refresh_token");
  
try {
// Execute the request using the GOP protocol
IopResponse response = client.execute(request, Protocol.GOP);
  
// Print the response body
System.out.println(response.getBody());
} catch (Exception e) {
// Handle any exceptions that may occur during the request execution
e.printStackTrace();
}
}
}
```

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

### Refresh Token in PHP

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

Demonstrates how to use the IopClient to refresh an access token in PHP.

```PHP
<?php
  
$url = "https://api-sg.aliexpress.com/rest";
$appkey = "Your-APPKEY";
$appSecret = "Your-APPSECRET";
  
$c = new IopClient($url, $appkey, $appSecret);
$request = new IopRequest('/auth/token/refresh');
$request->addApiParam('refresh_token', 'Your-refreshtoken');//Please obtain Your-refreshtoken from the create/token response.
  
var_dump($c->execute($request));
```

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

### POST /auth/token/create

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

Endpoint to create an access token after user authorization.

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

### Description
Creates an access token for the application after the user has successfully authorized the app.

### Method
POST

### Endpoint
/auth/token/create
```

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

### Construct Authorization URL

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

The base URL for initiating the OAuth authorization flow. Replace ${callback-url} and ${appkey} with your application's specific values.

```text
https://api-sg.aliexpress.com/oauth/authorize?response_type=code&force_auth=true&redirect_uri=${callback-url}&client_id=${appkey}
```

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

### POST /auth/token/create

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

Exchanges the temporary authorization code for an access token.

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

### Description
Exchanges the temporary code received from the callback URL for an access token. This request must be made to the open platform backend.

### Method
POST

### Parameters
- **code** (string) - Required - The temporary code received from the redirect_uri callback.

### Response
#### Success Response (200)
- **access_token** (string) - The token used for authenticated API requests.
- **refresh_token** (string) - Token used to refresh the access token.
- **expires_in** (integer) - Expiration time of the access token in seconds.
- **user_id** (string) - The unique identifier for the authorized user.
```

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

### POST /auth/token/refresh

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

Endpoint to refresh an existing access token.

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

### Description
Refreshes an existing access token to maintain application access to user data.

### Method
POST

### Endpoint
/auth/token/refresh
```

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

### Access Token Response JSON

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

The expected JSON response structure after successfully exchanging an authorization code for an access token.

```json
{
"gopErrorCode": "0",
"gopRequestId": "2141244f17116066265020000",
"gopResponseBody": "{\"refresh_token_valid_time\":1711779426000,
\"havana_id\":\"300002118000\",
\"expire_time\":1711693026000,
\"locale\":\"zh_CN\",
\"user_nick\":\"kr10400008150000\",
\"access_token\":\"Your-accesstoken\",
\"refresh_token\":\"Your-refreshtoken\",
\"user_id\":\"Your-UserID\",
\"account_platform\":\"buyerApp\",
\"refresh_expires_in\":172800,
\"expires_in\":86400,
\"sp\":\"ae\",
\"seller_id\":\"Your-sellerID\",
\"account\":\"Your-accont\",
\"code\":\"0\",
\"request_id\":\"2141244f17116066265020000\"}",
"success": true
}
```

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

### POST /auth/token/refresh

Source: https://openservice.aliexpress.com/doc/doc.htm?spm=a2o9m.11193487.0.0.372eee0cUB2sDo&nodeId=27493&docId=118729#/?docId=1590

Refreshes an existing access token using a valid refresh token. This operation returns a new access token and refresh token, resetting the access token's duration.

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

### Description
Refreshes the access token using a valid refresh token. This endpoint should be called when the access token has expired but the refresh token is still valid.

### Method
POST

### Endpoint
/auth/token/refresh

### Parameters
#### Request Body
- **refresh_token** (string) - Required - The refresh token obtained from the initial authorization or previous refresh response.

### Response
#### Success Response (200)
- **access_token** (string) - The new access token for API authentication.
- **refresh_token** (string) - The new refresh token to be used for future refreshes.
- **expires_in** (integer) - Remaining valid time of the access token in seconds.
- **refresh_expires_in** (integer) - Remaining valid time of the refresh token in seconds.
- **user_id** (string) - The user's ID.
- **code** (string) - Status code, '0' indicates success.
- **request_id** (string) - Unique identifier for the request.

#### Response Example
{
  "refresh_token_valid_time": 1716784148000,
  "havana_id": "3000021188814",
  "expire_time": 1714192160000,
  "locale": "zh_CN",
  "user_nick": "kr10404958150000",
  "access_token": "new_access_token",
  "refresh_token": "new_refresh_token",
  "user_id": "2637908814",
  "account_platform": "buyerApp",
  "refresh_expires_in": 5183988,
  "expires_in": 2592000,
  "code": "0",
  "request_id": "212a69f317116001605067741"
}
```
Tokens:
Raw