# Alibaba Cloud CloudESL API

> Alibaba Cloud CloudESL API on Apizie: 37 endpoints (Activates a base station device, Adds a base station device with the specified MAC address and automatically attempts to activate it, Add a template, Creates a user, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-cloudesl/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-cloudesl`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/cloudesl
- Page: https://apizie.tech/api/cloud/aliyun-cloudesl
- OpenAPI: https://apizie.tech/api/cloud/aliyun-cloudesl/openapi.json

Alibaba Cloud OpenAPI for CloudESL (cloudesl, version 2020-02-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Activates a base station device
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/activate-ap-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| ApMac | string | yes | The MAC address of the base station device |
| StoreId | string | yes | The store ID or custom store ID defined by the merchant |
| ExtraParams | string | no | A reserved parameter. Ignore this parameter |

### Adds a base station device with the specified MAC address and automatically attempts to activate it
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/add-ap-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| StoreId | string | yes | The store ID or custom store ID defined by the merchant |
| ApMac | string | yes | The MAC address of the base station device. You can call DescribeApDevices to obtain this value |
| Remark | string | no | The remarks |
| ClientToken | string | no | The client token |
| ExtraParams | string | no | A reserved parameter. Ignore this parameter |
| SerialNumber | string | no | The serial number (SN) of the device |

### Add a template
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/add-company-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| Scene | string | no | Scenarios. Select an appropriate scenario |
| ExtraParams | string | no | System extension field. Ignore this field |
| EslSize | string | yes | ESL size |
| TemplateName | string | yes | Template Name |
| Layout | integer | yes | Layout information |
| TemplateVersion | string | yes | Outlet template version |
| DeviceType | string | yes | Device type |
| TemplateType | string | no | Template type |
| IfPromotion | string | no | Specifies whether it is a promotion. Valid values: - true: Yes. - false: No |
| IfSourceCode | string | no | Indicates whether source tracing is enabled. Valid values: - true: Yes. - false: No |
| IfDefault | string | no | Specifies whether the template is the default one. Valid values: - true: Yes. - false: No |
| IfMember | string | no | Specifies whether it is for membership. Valid values: - true: Yes. - false: No |
| IfOutOfInventory | string | no | Indicates whether the item is out of stock. Valid values: - true: Yes. - false: No |
| Vendor | string | no | Device manufacturer |
| GroupId | string | no | Template group ID |
| TemplateSceneId | string | no | Custom Template ID |

### Creates a user
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/add-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| UserId | string | yes | The UID of the RAM user |
| ClientToken | string | no | The client token |
| ExtraParams | string | no | The system extension field. Ignore this parameter |

### Apply the version to outlets
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/apply-company-template-version-to-stores` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| TemplateVersion | string | yes | Outlet template version number |
| Stores | string | no | List of outlet IDs. Convert it to a JSON string |

### Assigns user permissions
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/assign-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| Stores | string | no | The list of store IDs |
| UserId | string | yes | The UID of the Alibaba Cloud RAM user |
| UserType | string | yes | The type of the user. Valid values: `USER_TYPE_COMPANY_ROOT`: Super merchant administrator. This role can create, read, update, and delete… |
| ExtraParams | string | no | The extended information |

### Creates or updates item information in batches. A maximum of 100 items can be processed per request, and…
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/batch-insert-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| StoreId | string | yes | The store ID or merchant-defined custom store ID. A maximum of 100 records can be inserted at a time |
| ExtraParams | string | no | The system extension field. Ignore this parameter |
| SyncByItemId | string | no | Specifies whether to update item information for other items with the same ItemId in the store. Default value: false. If this parameter is… |
| ItemInfo | string | yes | The list of item information (JSON-encoded) |

### Binds a CloudESL device
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/bind-esl-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| ItemBarCode | string | no | The item bar code |
| EslBarCode | string | yes | The ESL bar code |
| StoreId | string | yes | The store ID or the custom store ID defined by the merchant |
| Shelf | string | no | The shelf number in the display system |
| Layer | integer | no | The layer number in the display system |
| Column | string | no | The logical column in the display system |
| ExtraParams | string | no | The extended parameters |
| LayoutId | string | no | The layout ID. Only a single ID is supported |
| ContainerId | string | no | The container ID |
| ContainerName | string | no | The container name |
| LayoutName | string | no | The layout name |

### Adds a store
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/create-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| ParentId | string | no | The ID of the parent store |
| UserStoreCode | string | no | The custom store ID defined by the merchant |
| StoreName | string | yes | The store name |
| Phone | string | yes | The phone number of the store |
| ClientToken | string | no | The client token |
| ExtraParams | string | no | A system reserved field. Ignore this parameter |
| TimeZone | string | no | The time zone |
| BarCodeEncode | integer | no | The barcode encoding method. Valid values: 0: Code128. 1: EAN13. Default value: 0 |
| AutoUnbindOfflineEsl | string | no | 是否启用自动解绑离线价签 |
| AutoUnbindDays | integer | no | 自动解绑离线价签条件-价签离线天数 |

### Deletes a base station device with the specified MAC address
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/delete-ap-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| ApMac | string | yes | The MAC address of the base station device |
| StoreId | string | yes | The store ID or custom store ID defined by the merchant |
| ExtraParams | string | no | The ExtraParams |

### DeleteCompanyTemplate
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/delete-company-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| TemplateId | string | yes | Template ID |
| ExtraParams | string | no | System extension field. Ignore it. |

### Deletes a store item
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/delete-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| StoreId | string | yes | The store ID or merchant-defined custom store ID |
| ItemBarCode | string | yes | The bar code of the item |
| UnbindEslDevice | string | no | Specifies whether to unbind the CloudESL device that is bound to the item. Default value: false |

### Deletes a store
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/delete-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| StoreId | string | yes | The store ID or the custom store ID defined by the merchant |
| ExtraParams | string | no | A reserved field. Ignore this parameter |

### Deletes a user
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| UserId | string | yes | The UID of the RAM user |
| ExtraParams | string | no | The system extension field. Ignore this parameter |

### Queries information about access point (AP) devices
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-ap-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| StoreId | string | yes | The store ID or the custom store ID defined by the merchant |
| ApMac | string | no | The MAC address of the AP device |
| Status | string | no | The online or offline status of the device. Valid values: true: online. false: offline |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| PageNumber | integer | no | The page number. Default value: 1 |
| Model | string | no | The device model |
| BeActivate | string | no | The activation status of the device |
| ExtraParams | string | no | A reserved parameter. Ignore this parameter |

### DescribeAvailableEslModels
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-available-esl-models` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| ModelId | string | no | Device model ID |
| Name | string | no | Model name |
| PageNumber | integer | no | Page number |
| PageSize | integer | no | Page size |

### Queries the binding information between items and electronic shelf labels (ESLs)
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-binders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| ItemBarCode | string | no | The bar code of the item |
| EslBarCode | string | no | The bar code of the ESL. If you query by store ID and ESL bar code, you do not need to specify the shelf number or layer number |
| StoreId | string | yes | The store ID or custom store ID defined by the merchant |
| PageNumber | integer | no | The page number. Default value: 1 |
| ItemTitle | string | no | The name of the item |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| ExtraParams | string | no | A reserved field. Ignore this parameter |

### Version List
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-company-template-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| PageNumber | integer | no | Pagination parameter: current page number. Default value is 1 |
| PageSize | integer | no | Pagination parameter: number of entries per page. Default value is 10 |

### Incrementally queries the data binding status of price tags
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-esl-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| StoreId | string | no | The StoreId |
| FromDate | string | no | The FromDate |
| ToDate | string | no | The ToDate |
| PageNumber | integer | no | The PageNumber |
| PageSize | integer | no | The PageSize |

### Queries CloudESL device information
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-esl-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| PageNumber | integer | no | The page number. Default value: 1 |
| Type | string | no | The type of the electronic shelf label (ESL). Valid values: `ESL_TYPE_E_INK`: e-ink screen `ESL_TYPE_DM_LCD`: segment code screen… |
| TypeEncode | string | no | The type of the ESL. Valid values: `NORMAL`: standard `LOW_TEMPLATE`: low-temperature `THREE_COLOR`: three-color `ESL_TYPE_DM_LCD`:… |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| ToBatteryLevel | integer | no | The upper bound of the battery level range. The battery level is greater than or equal to the specified value |
| StoreId | string | yes | The store ID or custom store ID |
| EslStatus | string | no | The status of the ESL. Valid values: `ESL_STATUS_ONLINE`: online and bound `ESL_STATUS_OFFLINE`: offline and bound `ESL_STATUS_UNBIND`:… |
| EslBarCode | string | no | The barcode of the ESL |
| FromBatteryLevel | integer | no | The lower bound of the battery level range. The battery level is less than or equal to the specified value |
| ExtraParams | string | no | The extended parameters |

### Query device types by version
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-esl-model-by-template-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| TemplateVersion | string | no | The outlet template version number. |
| PageNumber | integer | no | Pagination parameter: the current page number. Default value: 1. |
| PageSize | integer | no | Pagination parameter: the number of entries to display per page. Default value: 10. |

### Queries item information
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| PageSize | integer | no | Pagination parameter: the number of entries to display per page. Default value: 20 |
| PageNumber | integer | no | Pagination parameter: the current page number. Default value: 1 |
| ItemTitle | string | no | The item title |
| SkuId | string | no | The SKU ID |
| StoreId | string | yes | The store ID or merchant-defined custom store ID |
| ItemBarCode | string | no | The item barcode |
| ItemId | string | no | The item ID |
| BePromotion | string | no | Specifies whether to display with the promotion template. Default value: false |
| ExtraParams | string | no | A system reserved field. Ignore this parameter |

### Query outlets to which the template is applied
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-store-by-template-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| TemplateVersion | string | no | Outlet Template Version number. |

### Queries the configuration information of a store
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-store-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| StoreId | string | yes | The store ID or the custom store ID defined by the merchant |
| ExtraParams | string | no | A reserved field of the system. Ignore this parameter |

### Queries the basic information about stores
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-stores` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| UserStoreCode | string | no | The custom store ID defined by the merchant |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| StoreName | string | no | The store name |
| ToDate | string | no | The end time of the store creation time range |
| StoreId | string | no | The store ID |
| FromDate | string | no | The start time of the store creation time range |
| ExtraParams | string | no | A reserved field of the system. Ignore this parameter |
| TemplateVersion | string | no | The version number of the template configured for the store |

### Template query
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-template-by-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| EslSize | string | no | ESL size |
| DeviceType | string | no | Device type |
| TemplateVersion | string | no | Outlet template version number; |
| PageNumber | integer | no | Pagination Parameters: current page number |
| PageSize | integer | no | Pagination Parameters: number of entries displayed per page. |

### Queries the operation log records of a user
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-user-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| ItemShortTitle | string | no | The short title of the item |
| OperationType | string | no | The log type. Valid values: `OPERATION_TYPE_BIND`: ESL binding. `OPERATION_TYPE_UNBIND`: ESL unbinding. `OPERATION_TYPE_FORCE_UPDATE`: ESL… |
| EslBarCode | string | no | The barcode of the ESL |
| FromDate | string | no | The start time for querying operation logs. The time follows the ISO 8601 standard in UTC+0. Format: yyyy-MM-ddTHH:mm:ssZ |
| ItemBarCode | string | no | The barcode of the item |
| StoreId | string | yes | The store ID or custom store ID defined by the merchant |
| ToDate | string | no | The end time for querying operation logs. The time follows the ISO 8601 standard in UTC+0. Format: yyyy-MM-ddTHH:mm:ssZ |
| LogId | string | no | The log ID |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| OperationStatus | string | no | The log status. Valid values: `OPERATION_STATUS_NEW`: new. `OPERATION_STATUS_SENT`: sent. `OPERATION_STATUS_DISPLAY`: displayed.… |
| PageNumber | integer | no | The page number. Default value: 1 |
| UserId | string | no | The Alibaba Cloud account ID |
| ExtraParams | string | no | A reserved field of the system. Ignore this parameter |

### Queries user information
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/describe-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| UserType | string | no | The user type. Valid values: `USER_TYPE_COMPANY_OWNER`: company owner account `USER_TYPE_COMPANY_ROOT`: senior company administrator… |
| PageNumber | integer | no | The page number. Default value: 1 |
| UserId | string | no | The UID of the RAM user |
| UserName | string | no | The username |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| ExtraParams | string | no | A reserved field of the system. Ignore this parameter |

### Queries the information about a single user
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/get-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| UserId | string | no | The UID of the Alibaba Cloud RAM user |
| ExtraParams | string | no | A system reserved field. Ignore this parameter |

### Query templates by group ID
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/query-template-list-by-group-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| PageNumber | integer | no | The PageNumber |
| GroupId | string | yes | The GroupId |
| PageSize | integer | no | The PageSize |

### Asynchronously add media material
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/sync-add-material` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| Name | string | yes | Material Name |
| Content | string | yes | Material Link |

### Revokes permissions from a user
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/unassign-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| UserId | string | yes | The UID of the RAM user |
| ExtraParams | string | no | A reserved parameter. Ignore this parameter |

### Unbinds an electronic shelf label (ESL) device
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/unbind-esl-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| EslBarCode | string | yes | The ESL bar code |
| ItemBarCode | string | no | The item bar code |
| Column | string | no | The logical column in the display system |
| StoreId | string | yes | The store ID or custom store ID defined by the merchant |
| Shelf | string | no | The shelf number in the display system |
| Layer | integer | no | The layer number in the display system |
| ExtraParams | string | no | The extended parameters |
| ContainerName | string | no | The ContainerName |

### Controls the LED light of an electronic shelf label (ESL) to change its frequency and color
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/update-esl-device-light` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| LedColor | string | yes | The LED color. Valid values: `GREEN`: green `RED`: red `BLUE`: blue `OFF`: off |
| Frequency | string | yes | The LED blinking frequency. Valid values: `ALWAYS`: always on `HEIGHT`: high frequency `MIDDLE`: medium frequency `NORMAL`: normal frequency |
| StoreId | string | yes | The store ID or merchant-defined custom store ID |
| ItemBarCode | string | no | The item bar code |
| LightUpTime | integer | yes | The duration for which the LED stays on. Unit: seconds. The value must be greater than 1 |
| EslBarCode | string | no | The ESL bar code |
| ExtraParams | string | no | The extended parameters |

### Modifies the basic information of a store
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/update-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| StoreId | string | yes | The store ID |
| UserStoreCode | string | no | The custom store ID defined by the merchant |
| StoreName | string | no | The store name |
| Phone | string | no | The supervision phone number of the local administration for industry and commerce where the store is located |
| ExtraParams | string | no | A system reserved field. Ignore this parameter |
| TemplateVersion | string | no | The store template version |
| Timezone | string | no | The time zone |
| BarCodeEncode | integer | no | The barcode encoding method. Valid values: 0: Code128. 1: EAN13. Default value: 0 |
| AutoUnbindOfflineEsl | string | no | 是否启用自动解绑离线价签 |
| AutoUnbindDays | integer | no | 自动解绑离线价签条件-价签离线天数 |

### Modifies the configuration information of a store
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/update-store-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |
| NotificationSilentTimes | string | no | The silent periods configured by the user during which notification messages are not sent. The value is a JSON list in minutes. Each JSON… |
| EnableNotification | string | no | Specifies whether to enable DingTalk exception message notifications. Set to true to enable or false to disable |
| StoreId | string | yes | The store ID or a custom store ID defined by the merchant |
| NotificationWebHook | string | no | The webhook URL for DingTalk messages |
| ExtraParams | string | no | The system extension field. Ignore this parameter |
| SubscribeContents | string | no | The subscription content |

### version
`POST https://apizie.tech/v1/cloud:aliyun-cloudesl/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cloudesl.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-cloudesl/activate-ap-device" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud CloudESL API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-cloudesl/activate-ap-device with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud CloudESL API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud CloudESL itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud CloudESL API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-cloudesl.

### What is the status of the Alibaba Cloud CloudESL API?
Needs your own provider key (bring your own key)