接口说明
更新时间：2021-06-23
创建站点
接口描述
本接口用于创建 AIPAGE 站点。支持批量创建。创建接口为同步接口，调用成功后会自动下单并扣款，扣款成功后会开始创建资源，最终返回创建的所有资源详情。
注意事项
- 请务必在账户中提前预留足够的金额保证预付费订单的自动扣款成功，否则调用该 API 会失败并返回错误。
- 如果在 24 小时内使用相同的参数和 clientToken，第二次则不会进行扣费购买，并返回上次订单创建的站点列表。
- 创建前当前账户必须在 https://console.bce.baidu.com/aipage/ 下过单之后才可使用此接口，在控制台下单后表示您同意我们使用您的 ak/sk 对资源进行操作。
- AIPAGE 的资源管理是基于百度云账户 accountId，所有子账户和主账户 accountId 相同，共享所有已创建资源的管理员。
- 下单并创建好资源之后，当前账户(api 中使用的 ak/sk 用户)即拥有所有资源的管理员权限，后续续费/变配该资源时必须仍有该创建者操作，无法转移。
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/site/new?clientToken={clientToken} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{
8 "items": [
9 {
10 "config": {
11 "comboName": "site_miniprogram_2",
12 "count": 1,
13 "name": "321",
14 "time": 1
15 },
16 }
17 ]
18}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| items | List<SiteCreateItemModel> | 是 | RequestBody参数 | 创建的站点配置 |
SiteCreateItemModel
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| config | SiteCreateItemConfigModel | 是 | RequestBody参数 | 站点配置 |
SiteCreateItemConfigModel
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| comboName | String | 是 | RequestBody参数 | 套餐名称，具体见套餐规格，套餐名称例如 site_miniprogram_2 |
| name | String | 是 | RequestBody参数 | 站点名称，2-20 长度的英文数字字符，不能包含特殊字符 |
| count | Number | 是 | RequestBody参数 | 站点数量，数量限制为 1 - 10 |
| time | Number | 是 | RequestBody参数 | 购买的站点时长，数量限制为 1 - 10 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回订单 ID 及创建的资源列表详情 |
| success | Boolean | 表示当前操作是否成功 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/site/new?clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{
8 "items": [{
9 "config": {
10 "comboName": "site_miniprogram_2", // 套餐名称，可以根据获取套餐接口获取到，这里是全网门户-展示版套餐
11 "name": "openapi_site1", // 创建的站点名称
12 "time": 2, // 创建的站点时长。单位为年，这里代表创建了一个时长为 2 年的站点。
13 "count": 1 // 创建的站点个数。这里为 1 代表创建 1 个时长两年名称为「openapi_site1」套餐规格为「全网门户-基础版」站点。
14 }
15 }, {
16 "config": {
17 "comboName": "miniprogram_3", // 同上，套餐名称，这里代表是小程序门户-官网版套餐
18 "name": "openapi_site2",
19 "time": 1, // 创建的站点时长。单位为年，这里为 1 代表创建的站点时长为 1。
20 "count": 2 // 创建的站点个数。这里为 2 代表最终需要创建 2 个时长一年名称为 「openapi_site2」套餐规格为 「小程序门户-官网版」站点。
21 }
22 }]
23}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "result": {
9 "orderId": "e9134567-e838-b4c7-45e4-f6225dd26676",
10 "sites": [
11 {
12 "id": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f", // 站点 ID
13 "name": "openapi_site1", // 创建站点的名称
14 "type": 13, // 标记套餐的类型，与 productSerie + productType 代表的意义相同
15 "productSerie": "site_miniprogram_", // 产品系列，此处代表全网门户
16 "productType": "1", // 产品版本，此处代表基础版
17 "status": "RUNNING", // 站点状态
18 "createTime": "2019-04-18T08:54:16.000Z", // 创建时间
19 "expireTime": "2021-04-18T08:54:16.000Z", // 过期时间
20 "isOldData": false // 是否为试用版本站点，true 代表未付费的前期试用站点
21 },
22 {
23 "id": "835d097d-3b7e-4c01-9646-262cf75d30d6",
24 "name": "openapi_site2",
25 "type": 51,
26 "productSerie": "miniprogram_",
27 "productType": "3",
28 "status": "RUNNING",
29 "createTime": "2019-04-18T08:52:17.000Z",
30 "expireTime": "2020-04-18T08:52:17.000Z",
31 "isOldData": false
32 },
33 {
34 "id": "0f76a86c-d676-44d2-8c1f-536ce220fc0d",
35 "name": "openapi_site2",
36 "type": 51,
37 "productSerie": "miniprogram_",
38 "productType": "3",
39 "status": "RUNNING",
40 "createTime": "2019-04-18T08:52:17.000Z",
41 "expireTime": "2020-04-18T08:52:17.000Z",
42 "isOldData": false
43 }
44 ]
45 },
46 "success": true
47}站点续费
接口描述
本接口用于续费 AIPAGE 站点。支持批量续费。创建接口为同步接口，调用成功后会自动下单并扣款，扣款成功之后会开始续费资源，最终返回所有续费的资源详情。
注意事项
- 请务必在账户中提前预留足够的金额保证预付费订单的自动扣款成功，否则调用该 API 会失败并返回错误。
- 如果在 24 小时内使用相同的参数和 clientToken，第二次则不会进行扣费续费，并返回上次续费订单操作的资源列表详情。
- 所续费的站点资源必须是已经通过 https://console.bce.baidu.com/aipage/ 或者上述创建站点接口创建的已付费站点。平台前期公测期间创建的免费站点无法直接调用该接口进行续费（通过站点详情 isOldData 可以区分是否是公测测试站点）。
- 续费站点操作的百度云账户必须和创建资源时的用户相同（资源管理员），否则调用该 API 会失败并返回错误。
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/site/renew?clientToken={clientToken} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{
8 "items": [{
9 "config": {
10 "siteId": "xx", // 站点 ID，创建成功之后会返回。一个 36 位长度的 v4 版本 uuid
11 "time": 1, // 续费时长
12 },
13 }]
14}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| items | List<SiteRenewItemModel> | 是 | RequestBody参数 | 续费的站点配置 |
SiteRenewItemModel
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| config | SiteRenewItemConfigModel | 是 | RequestBody参数 | 续费内容配置 |
SiteRenewItemConfigModel
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| time | String | 是 | RequestBody参数 | 续费时间，单位为年，1 - 10 的自然整数 |
| siteId | String | 否 | RequestBody参数 | 创建时分配的站点 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回订单 ID 及创建的资源列表详情 |
| success | Boolean | 返回是否操作成功 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/site?clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{
8 "items": [{
9 "config": {
10 "siteId": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",
11 "time": 2, // 续费该站点的时长。单位为年，这里代表该站点续费 2 年。
12 }
13 }, {
14 "config": {
15 "siteId": "835d097d-3b7e-4c01-9646-262cf75d30d6",
16 "time": 1, // 续费该站点的时长。单位为年，这里代表该站点续费 1 年。
17 }
18 }]
19}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7// 如果 24 小时内 clientToken 和参数都相同，则直接返回上次 clientToken 所创建的订单相关内容
8{
9 "result": {
10 "orderId": "f6225dd2-e838-b4c7-45e4-f6225dd26676",
11 "sites": [
12 {
13 "id": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f", // 站点 ID
14 "name": "openapi_site", // 站点的名称
15 "type": 13, // 标记套餐的类型，与 productSerie + productType 代表的意义相同
16 "productSerie": "site_miniprogram_", // 产品系列，此处代表全网门户
17 "productType": "1", // 产品版本，此处代表基础版
18 "status": "RUNNING", // 站点状态
19 "createTime": "2019-04-18T08:54:16.000Z", // 创建时间
20 "expireTime": "2023-04-18T08:54:16.000Z", // 过期时间
21 "isOldData": false // 是否为试用版本用户
22 },
23 {
24 "id": "835d097d-3b7e-4c01-9646-262cf75d30d6",
25 "name": "openapi_miniprogram",
26 "type": 51,
27 "productSerie": "miniprogram_",
28 "productType": "4",
29 "status": "RUNNING",
30 "createTime": "2019-04-18T08:52:17.000Z",
31 "expireTime": "2021-04-18T08:52:17.000Z",
32 "isOldData": false
33 }
34 ]
35 },
36 "success": true
37}站点升级
接口描述
本接口用于升级 AIPAGE 站点。支持批量升级。创建接口为同步接口，调用成功后会自动下单并扣款，扣款成功之后会开始升级资源，升级成功会返回所有升级的资源详情。
注意事项
- 请务必在账户中提前预留足够的金额保证预付费订单的自动扣款成功，否则调用该 API 会失败并返回错误。
- 升级站点操作的百度云账户必须和创建站点时的用户相同（资源管理员），否则调用该 API 会失败并返回错误。
- 如果在 24 小时内使用相同的参数和 clientToken，第二次则不会进行扣费升级，并直接返回上次订单 ID 和升级的站点列表详情。
- 所续费的站点资源必须是已经通过 https://console.bce.baidu.com/aipage/ 或者上述创建站点接口创建的已付费站点。平台前期公测期间创建的免费站点无法直接调用该接口进行升级（通过站点详情 isOldData 可以区分是否是公测测试站点）。
- 升级接口单笔订单仅支持升级一个资源，多个资源仅有第一个资源（参数中 items 中的第一个 item）有效。
-
套餐只能升级不能降级，全网门户系列无法升级为小程序门户系列，官网版本无法通过升级接口变为基础版本。
- 全网门户官网版（site_miniprogram_3）无法变为全网门户展示版（site_miniprogram_2）
- 小程序门户官网版（miniprogram_3）无法变为小程序门户展示版（miniprogram_2）
- 全网门户展示版（site_miniprogram_2）无法变为小程序门户营销版（miniprogram_4）
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/site/resize?clientToken={clientToken} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{
8 // 目前升级接口仅支持单资源升级，items 数组中仅第一个 item 有效
9 "items": [{
10 "config": {
11 "siteId": "", // 站点 ID，创建成功之后返回的站点信息中的 ID
12 "comboName": "site_miniprogram_4", // 升级后的套餐
13 },
14 }]
15}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| items | List<SiteResizeItemModel> | 是 | RequestBody参数 | 创建的站点配置 |
SiteResizeItemModel
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| config | SiteResizeItemConfigModel | 是 | RequestBody参数 | 变配配置 |
SiteResizeItemConfigModel
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| comboName | String | 是 | RequestBody参数 | 变配套餐配置，详见套餐配置，例如 site_miniprogram_4 |
| siteId | String | 否 | RequestBody参数 | 创建时分配的站点 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回订单 ID 及创建的资源列表详情 |
| success | Boolean | 返回是否成功操作 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/site?clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7// items 目前仅支持一个元素，多个元素会被忽略，最终只有第一个元素会出现在订单中
8{
9 "items": [{
10 "config": {
11 "siteId": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",
12 "comboName": "site_miniprogram_4", // 升级后的站点套餐版本，这里的意思是升级该站点到 全网门户-营销版
13 }
14 }]
15}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7// 如果 24 小时内 clientToken 和参数都相同，则直接返回上次 clientToken 所创建的订单相关内容
8{
9 "result": {
10 "orderId": "5c08ca2f-e838-b4c7-45e4-f6225dd26676",
11 "sites": [
12 {
13 "id": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f", // 站点 ID
14 "name": "openapi_site", // 创建站点的名称
15 "type": 101, // 标记套餐的类型，与 productSerie + productType 代表的意义相同
16 "productSerie": "site_miniprogram_", // 产品系列，此处代表全网门户
17 "productType": "4", // 产品版本，此处代表营销版
18 "status": "RUNNING", // 站点状态
19 "createTime": "2019-04-18T08:54:16.000Z", // 创建时间
20 "expireTime": "2023-04-18T08:54:16.000Z", // 过期时间
21 "isOldData": false // 是否为试用版本用户
22 }
23 ]
24 },
25 "success": true
26}站点列表
接口描述
本接口用于展示 AIPAGE 站点列表，返回当前用户的站点列表及详情。
注意事项
- limit 参数必须为 1 - 1000 的有效整数，默认为 10，不合法的 limit 参数则会无法调用此 API。
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1GET /v{version}/site/list?limit=${limit}&marker=${marker} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| limit | String | 否 | Query参数 | 返回的站点数量，默认为 10 |
| marker | String | 否 | Query参数 | 创建的站点标记，代表从这个标记表示的站点开始获取 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回订单 ID 及创建的资源列表详情 |
| success | Boolean | 返回是否操作成功 |
请求示例-1
Plain Text
1GET https://aipage.baidubce.com/v1/site/list?limit=3
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例-1
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4Server: BWS
5
6{
7 "success":true,
8 "result":{
9 "isTruncated": true, // 代表后续仍有数据
10 "nextMarker":"b9ef663944b741789eaa40528c8c6bdf", // 获取下一页数据时参数中需传入 marker
11 "sites": [ // 站点详情列表
12 {
13 "id":"71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",
14 "name":"openapi_site",
15 "type":101,
16 "productSerie":"site_miniprogram_",
17 "productType":"4",
18 "createTime":"2019-04-18T08:54:16.000Z",
19 "status":"STOPPED",
20 "expireTime":"2019-04-18T08:54:16.000Z",
21 "isOldData":true
22 },
23 {
24 "id":"835d097d-3b7e-4c01-9646-262cf75d30d6",
25 "name":"openapi_miniprogram",
26 "type":101,
27 "productSerie":"site_miniprogram_",
28 "productType":"4",
29 "createTime":"2019-04-18T08:52:17.000Z",
30 "status":"STOPPED",
31 "expireTime":"2019-04-18T08:52:17.000Z",
32 "isOldData":true
33 },
34 {
35 "id":"0f76a86c-d676-44d2-8c1f-536ce220fc0d",
36 "name":"openapi_miniprogram",
37 "type":101,
38 "productSerie":"site_miniprogram_",
39 "productType":"4",
40 "createTime":"2019-04-18T08:50:00.000Z",
41 "status":"STOPPED",
42 "expireTime":"2019-04-18T08:50:00.000Z",
43 "isOldData":true
44 }
45 ]
46 }
47}站点详情
接口描述
本接口用于展示 AIPAGE 站点详情，返回查询的站点详细内容。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1GET /v{version}/site/{siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| siteId | String | 是 | URL参数 | 站点 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回查询的站点详情 |
| success | Boolean | 返回是否操作成功 |
请求示例
Plain Text
1GET https://aipage.baidubce.com/v1/site/71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例-1
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true,
9 "result": {
10 "id":"71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",
11 "name":"openapi_site",
12 "type":101,
13 "createdAt":"2019-04-18T08:54:16.000Z",
14 "productSerie":"site_miniprogram_",
15 "productType":"4",
16 "createTime":"2019-04-18T08:54:16.000Z",
17 "status":"RUNNING",
18 "expireTime":"2020-04-18T08:54:16.000Z",
19 "isOldData":false
20 }
21}更改站点名称
接口描述
本接口用于更改 AIPAGE 站点的名称，最终返回查询的站点详情。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/site/{siteId}?action=name&clientToken={clientToken} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Body: {"name": "xxxx"}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| siteId | String | 是 | URL参数 | 站点 ID |
| name | String | 是 | Body参数 | 修改后的站点名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回查询的站点详情 |
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/site/71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f?action=name&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{"name": "test name"}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true,
9 "result": {
10 "id": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",
11 "name": "test name",
12 "type": 101,
13 "productSerie": "site_miniprogram_",
14 "productType": "4",
15 "createTime": "2019-04-18T08:54:16.000Z",
16 "status": "RUNNING",
17 "expireTime": "2020-04-18T08:54:16.000Z",
18 "isOldData": false
19 }
20}获取角色列表
接口描述
本接口用于查询 AIPAGE 站点配置的管理角色列表。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1GET /v{version}/role/list?siteId={siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| siteId | String | 是 | URL参数 | 站点 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回查询的站点成员列表 |
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1GET https://aipage.baidubce.com/v1/role/list?siteId=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success": true,
9 "result": [
10 {
11 "aclNames": "站点创建者，所有权限",
12 "name": "系统管理员",
13 "id": "23f5a31c-5d56-4bbb-a35e-46c91d73c5ed",
14 "acl": "admin",
15 "createdAt": "2020-05-25T04:31:04.000Z",
16 "updatedAt": "2020-05-25T04:31:04.000Z",
17 "deletedAt": "1970-01-01T00:00:00.000Z",
18 "siteId": "99f4f0ed-79f8-4426-9b43-650fdc364af4",
19 "usersNum": 1
20 },
21 {
22 "aclNames": "用户管理外所有权限",
23 "name": "副站长",
24 "id": "328a4db0-c942-411b-ae39-a2a8d58fa6aa",
25 "acl": "editor",
26 "createdAt": "2020-12-10T07:44:06.000Z",
27 "updatedAt": "2020-12-10T07:44:06.000Z",
28 "deletedAt": "1970-01-01T00:00:00.000Z",
29 "siteId": "99f4f0ed-79f8-4426-9b43-650fdc364af4",
30 "usersNum": 1
31 },
32 {
33 "aclNames": "除续费外所有权限",
34 "name": "站长",
35 "id": "5a2dde29-0226-4428-a35c-6c3747c9cc56",
36 "acl": "site-admin",
37 "createdAt": {
38 "fn": "NOW",
39 "args": []
40 },
41 "updatedAt": {
42 "fn": "NOW",
43 "args": []
44 },
45 "deletedAt": "1970-01-01T00:00:00.000Z",
46 "siteId": "99f4f0ed-79f8-4426-9b43-650fdc364af4",
47 "usersNum": 0
48 }
49 ]
50}新增站点角色
接口描述
本接口用于新增 AIPAGE 站点自定义角色，最终返回操作结果。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/role?clientToken={clientToken}&siteId={siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Body: {"name": "role name", "acl": "1,2,3"}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | URL参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| siteId | String | 是 | URL参数 | 站点 ID |
| name | String | 是 | Body参数 | 角色名称 |
| acl | String | 是 | Body参数 | 角色权限列表，多个英文逗号隔开，权限ID参考下表 |
系统角色ID说明
| 权限说明 | 权限ID |
|---|---|
| 设计、发布、预览网站 | 1 |
| 站点管理 | 3 |
| 内容管理 | 4 |
| 互动管理 | 5 |
| 用户管理 | 6 |
| 开发者中心 | 7 |
| 系统配置 | 8 |
| 会员管理 | 9 |
| 预约管理 | 10 |
| 电商管理 | 11 |
| 客服管理 | 12 |
| 应用中心 | 14 |
| 搜索优化 | 15 |
| 编辑小程序 | 100 |
| 发布审核小程序 | 300 |
| 小程序管理 | 500 |
更细粒度的功能权限ID参考站点后台自定义角色配置接口。
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/role?siteId=71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{"name": "自定义角色", "acl": "1,3,5"}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success": true,
9 "result": {
10 "aclNames": "设计、发布、预览网站、站点管理、互动管理",
11 "name": "自定义角色",
12 "createdAt": {
13 "fn": "NOW",
14 "args": []
15 },
16 "updatedAt": {
17 "fn": "NOW",
18 "args": []
19 },
20 "deletedAt": "1970-01-01T00:00:00.000Z",
21 "id": "42955978-a862-423e-9616-0854e28b75ce",
22 "siteId": "99f4f0ed-79f8-4426-9b43-650fdc364af4",
23 "acl": "1,3,5"
24 }
25}删除站点角色
接口描述
本接口用于删除 AIPAGE 指定站点自定义角色，返回操作结果
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
- 内置系统角色不允许删除
请求结构
Plain Text
1DELETE /v{version}/role/{roleId}?clientToken={clientToken}&siteId={siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | URL参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| siteId | String | 是 | URL参数 | 站点 ID |
| roleId | String | 是 | PATH参数 | 角色 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1DELETE https://aipage.baidubce.com/v1/role/006710be-3f41-410f-96da-1219eefc691e?siteId=71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true
9}修改站点角色
接口描述
本接口用于修改 AIPAGE 站点角色的名称、权限信息，返回操作结果
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1PUT /v{version}/role/{roleId}?clientToken={clientToken}&siteId={siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Body: {"name": "new name", "acl", "3,5"}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | URL参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| siteId | String | 是 | URL参数 | 站点 ID |
| roleId | String | 是 | PATH参数 | 角色 ID |
| name | String | 是 | Body参数 | 角色新名称 |
| acl | String | 是 | Body参数 | 角色新权限 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1PUT https://aipage.baidubce.com/v1/role/006710be-3f41-410f-96da-1219eefc691e?siteId=71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{"acl": "1,3", "name": "新角色名称"}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true
9}获取成员列表
接口描述
本接口用于查询 AIPAGE 站点管理成员列表。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1GET /v{version}/user/list?siteId={siteId}&clientToken={clientToken} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| siteId | String | 是 | URL参数 | 站点 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回查询的站点成员列表 |
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1GET https://aipage.baidubce.com/v1/user/list?siteId=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success": true,
9 "result": [
10 {
11 "isBanned": false,
12 "isAgent": false,
13 "phone": "",
14 "oauthData": {},
15 "id": "babd875e-6fae-49b7-80c5-292e8a09c30b",
16 "type": 0,
17 "showName": "zt0807****",
18 "realName": "zt0807****",
19 "qq": "",
20 "status": 0,
21 "oauthType": 0,
22 "portrait": "",
23 "createdAt": "2017-12-22T03:18:03.000Z",
24 "updatedAt": "2020-12-02T03:18:17.000Z",
25 "deletedAt": "1970-01-01T00:00:00.000Z",
26 "ap_user_site": {
27 "createdAt": "2020-05-25T04:31:04.000Z",
28 "updatedAt": "2020-05-25T04:31:04.000Z",
29 "siteId": "99f4f0ed-79f8-4416-9b43-650fdc364af4",
30 "userId": "babd875e-6fae-49bb-80c5-292e8109c30b"
31 },
32 "roles": [
33 {
34 "aclNames": "站点创建者，所有权限",
35 "name": "系统管理员",
36 "id": "23f5a31c-5d56-4bbb-a35e-46c91d73c5ed",
37 "acl": "admin",
38 "createdAt": "2020-05-25T04:31:04.000Z",
39 "updatedAt": "2020-05-25T04:31:04.000Z",
40 "deletedAt": "1970-01-01T00:00:00.000Z",
41 "siteId": "99f4f0ed-79f8-4426-9b43-650fdc364af4",
42 "ap_user_role": {
43 "aclNames": "",
44 "createdAt": "2020-05-25T04:31:04.000Z",
45 "updatedAt": "2020-05-25T04:31:04.000Z",
46 "roleId": "23f5a31c-5d56-4bbb-a35e-46c91d73c5ed",
47 "userId": "babd875e-6fae-49b7-80c5-292e8109c30b"
48 },
49 "label": "系统管理员",
50 "value": "23f5a31c-5d56-4bbb-a35e-46c91d73c5ed"
51 }
52 ],
53 "aclName": "系统管理员",
54 "isAdmin": true
55 }
56 ]
57}新增站点第三方成员
接口描述
本接口用于新增 AIPAGE 站点第三方平台管理成员并设置角色，最终返回操作结果。添加的用户通过第三方平台oauth免登进入管理后台，不需要有百度智能云账号。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
- 使用本接口的前提是站点管理员已申请并完成 AIPAGE 第三方登录接入
请求结构
Plain Text
1POST /v{version}/user?clientToken={clientToken}&siteId={siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Body: {"username": "xxxx", "nickname": "xxx", "uid": "001", "app": "appName", "role": "editor", "roleId": ""}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | URL参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| siteId | String | 是 | URL参数 | 站点 ID |
| username | String | 否 | Body参数 | 成员账号名 |
| nickname | String | 是 | Body参数 | 成员账号昵称 |
| portrait | String | 否 | Body参数 | 成员头像图片地址 |
| uid | String | 是 | Body参数 | 成员账号标识ID，需保持唯一 |
| app | String | 是 | Body参数 | 第三方平台oauth登录应用标识 |
| role | String | 否 | Body参数 | 设置成员的内置角色标识，参考下方内置角色说明 |
| roleId | String | 否 | Body参数 | 设置成员的自定义角色ID，从角色列表中获取 |
内置角色说明
| 角色标识 | 角色名称 | 角色权限 |
|---|---|---|
| site-admin | 站长 | 除续费外所有权限 |
| editor | 副站长 | 除续费和用户管理外所有权限 |
| dnr-user | 域名服务商用户 | 除续费、用户管理、域名管理外所有权限 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/user?siteId=71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{"nickname": "nickname", "uid": "123", "role": "editor", "app": "app name"}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true
9}修改站点成员
接口描述
本接口用于修改 AIPAGE 站点成员的昵称、头像信息，返回操作结果
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1PUT /v{version}/user/{userId}?clientToken={clientToken}&siteId={siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Body: {"showName": "new name"}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| siteId | String | 是 | URL参数 | 站点 ID |
| userId | String | 是 | PATH参数 | 成员 ID |
| showName | String | 否 | Body参数 | 成员新昵称 |
| portrait | String | 否 | Body参数 | 成员头像图片地址 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1PUT https://aipage.baidubce.com/v1/user/006710be-3f41-410f-96da-1219eefc691e?siteId=71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{"showName": "new-name"}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true
9}删除站点成员
接口描述
本接口用于删除 AIPAGE 指定站点非系统管理员成员，返回操作结果
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
- 删除只删除账户在指定站点的角色，同个账户在其他站点的角色不受影响
请求结构
Plain Text
1DELETE /v{version}/user/{userId}?clientToken={clientToken}&siteId={siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| siteId | String | 是 | URL参数 | 站点 ID |
| userId | String | 是 | PATH参数 | 成员 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1DELETE https://aipage.baidubce.com/v1/user/006710be-3f41-410f-96da-1219eefc691e?siteId=71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true
9}设置成员角色
接口描述
本接口用于设置或修改 AIPAGE 站点成员的角色
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/user/setRole?clientToken={clientToken}&siteId={siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Body: {"id": "user id", "roleId": "role id"}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| siteId | String | 是 | URL参数 | 站点 ID |
| id | String | 是 | Body参数 | 成员ID |
| roleId | String | 是 | Body参数 | 角色ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/user/setRole?siteId=71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{"id": "42955978-a862-423e-9616-0854e28b75ce", "roleId": "23f5a31c-5d56-4bbb-a35e-46c91d73c5ed"}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true
9}获取域名配置
接口描述
本接口用于查询 AIPAGE 站点域名配置信息，返回站点对应的大陆和香港的cname解析地址。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1GET /v{version}/domain/conf?siteId={siteId}&clientToken={clientToken} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| siteId | String | 是 | URL参数 | 站点 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回查询的站点成员列表 |
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1GET https://aipage.baidubce.com/v1/domain/conf?siteId=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success": true,
9 "result": {
10 "hk": "aeae4a83ac456.hk.aipage.com", // 香港解析地址
11 "gz": "aeae4a83ac456.aipage.com" // 大陆解析地址
12 }
13}查询域名列表
接口描述
本接口用于查询 AIPAGE 站点域名绑定列表，返回查询结果。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1GET /v{version}/domain/list?siteId={siteId}&clientToken={clientToken} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| siteId | String | 是 | URL参数 | 站点 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回查询的站点成员列表 |
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1GET https://aipage.baidubce.com/v1/domain/list?siteId=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success": true,
9 "result": [
10 {
11 "bindAt": "2020-12-07 19:06",
12 "id": "296c0f19-684f-4bce-92b7-3c46c0e2641a",
13 "domain": "aipage.cn",
14 "redirect": "",
15 "status": 34, // 34表示解析成功的大陆域，19表示解析成功的香港域名
16 "createdAt": "2020-12-07T11:06:21.000Z",
17 "updatedAt": "2020-12-07T11:07:14.000Z",
18 "siteId": "6242ee49-2966-4ef1-8b1d-113ab39f154c"
19 }
20 ]
21}新增站点域名
接口描述
本接口用于新增 AIPAGE 站点绑定域名，添加前需确保域名DNS解析已在全国生效，否则可能会报错解析错误。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
- 发布到大陆的域名需要通过备案，否则将被封禁
请求结构
Plain Text
1POST /v{version}/domain?clientToken={clientToken}&siteId={siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Body: {"domain": "www.aipage.com", "region": "gz"}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | URL参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| siteId | String | 是 | URL参数 | 站点 ID |
| domain | String | 是 | Body参数 | 域名 |
| region | String | 否 | Body参数 | 发布区域，大陆: gz 香港: hk，默认是大陆 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/domain?siteId=71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{"domain": "www.aipage.com", "region": "gz"}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success": true,
9 "result": [
10 {
11 "bindAt": "2020-12-07 19:06",
12 "id": "296c0f19-684f-4bce-92b7-3c46c0e2641a",
13 "domain": "aipage.com",
14 "redirect": "",
15 "status": 34, // 34表示解析成功的大陆域，19表示解析成功的香港域名
16 "createdAt": "2020-12-07T11:06:21.000Z",
17 "updatedAt": "2020-12-07T11:07:14.000Z",
18 "siteId": "6242ee49-2966-4ef1-8b1d-113ab39f154c"
19 }
20 ]
21}删除站点域名
接口描述
本接口用于删除 AIPAGE 指定站点绑定域名，返回操作结果
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
- 删除域名后对应域名将无法访问站点，请谨慎操作
请求结构
Plain Text
1DELETE /v{version}/domain/{domainId}?clientToken={clientToken}&siteId={siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | URL参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| siteId | String | 是 | URL参数 | 站点 ID |
| domainId | String | 是 | PATH参数 | 域名 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1DELETE https://aipage.baidubce.com/v1/domain/006710be-3f41-410f-96da-1219eefc691e?siteId=71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true
9}设置域名301跳转
接口描述
本接口用于设置或修改 AIPAGE 站点域名301跳转配置，返回操作结果
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
- 域名301配置修改后大概10分钟后生效，跳转到域名需加到站点域名中，禁止多次跳转
请求结构
Plain Text
1POST /v{version}/domain/setRedirect?clientToken={clientToken}&siteId={siteId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Body: {"domain": "aipage.com", "redirect": "www.aipage.com"}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 是 | URL参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
| siteId | String | 是 | URL参数 | 站点 ID |
| domain | String | 是 | Body参数 | 待跳转域名 |
| redirect | String | 否 | Body参数 | 跳转目标域名，如果不设置或设置空则表示取消跳转 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否操作成功 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/domain/setRedirect?siteId=71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{"domain": "aipage.com", "redirect": "www.aipage.com"}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true
9}订单列表
接口描述
本接口用于展示 AIPAGE 订单列表，按查询条件返回该超管账户下的订单列表。
注意事项
- limit 参数必须为 1 - 1000 的有效整数，默认为 10，不合法的 limit 参数则会无法调用此 API。
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1GET /v{version}/order/list HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| siteId | String | 是 | Query参数 | 创建时分配的站点 ID |
| page | String | 否 | Query参数 | 分页页码，默认为 1 |
| perPage | String | 否 | Query参数 | 每页条数，默认为 10 |
| type | String | 否 | Query参数 | 订单类型 |
| status | String | 否 | Query参数 | 订单状态 |
| platform | String | 否 | Query参数 | 渠道类型 |
| orderId | String | 否 | Query参数 | 订单id |
| memberId | String | 否 | Query参数 | 会员id |
| datetime | String | 否 | Query参数 | 日期区间以秒为单位格式为:开始日期,结束日期，例如: 1623254400,1623513599 |
| orderBy | String | 否 | Query参数 | 排序字段 |
| orderDir | String | 否 | Query参数 | 排序方式 生序: asc 降序: desc |
订单类型说明
| 名称 | 值 |
|---|---|
| 全部类型 | |
| 普通订单 | 0 |
| 拼团订单 | 1 |
| 秒杀订单 | 3 |
| 预约订单 | 4 |
订单状态说明
| 名称 | 值 |
|---|---|
| 代付款 | 1 |
| 代发货 | 2 |
| 代收货 | 3 |
| 申请退款 | 4 |
| 已完成 | 5 |
| 已退款 | 6 |
渠道类型说明
| 名称 | 值 |
|---|---|
| 全部渠道 | |
| 电脑网站订单 | 10 |
| 手机网站订单 | 11 |
| 百度小程序 | 2 |
| 微信小程序 | 1 |
| 支付宝小程序 | 3 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回总条数count及订单列表集合rows |
| success | Boolean | 返回是否操作成功 |
请求示例-1
Plain Text
1GET https://aipage.baidubce.com/v1/order/list
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4query: { siteId: "4aee2098-7c99-4253-9844-32194d25428e",type: 0,orderId: "111",memberId: "5a5e4e86-e5cc-41c9-9f15-30d94a27a5d4",status: 2,page:1,perPage: 10,orderBy:"purchasePrice",orderDir:"desc",datetime: "1623254400,1623513599",platform: 10}响应示例-1
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4Server: BWS
5
6{
7"success":true,
8"result":{
9 "count":2609,
10 "rows":[
11 {
12 "info":{},
13 "address":{},
14 "detail":{
15 "subject":"无预约时间段测试预约支付"
16 },
17 "id":"b19440c0-582a-4a19-8800-19e229c145c6",
18 "type":4,
19 "siteId":"4aee2098-7c99-4253-9844-32294d25428e",
20 "memberId":"5a5e4e86-e5cc-41c9-9f15-20d94a27a5d4",
21 "productId":"0e6f1308-1865-4bca-aa46-735aabd1b14c",
22 "status":0,
23 "purchasePrice":1200,
24 "fromPlatform":1,
25 "goodsType":0,
26 "logisticsCom":"",
27 "logisticsNum":"",
28 "remark":"",
29 "feedback":"",
30 "payAt":"1970-01-01T00:00:00.000Z",
31 "createdAt":"2021-06-15T05:23:57.000Z",
32 "updatedAt":"2021-06-15T06:24:00.000Z",
33 "deletedAt":"1970-01-01T00:00:00.000Z",
34 "orderDetail":[],
35 "member":{
36 "name":"张三",
37 "id":"5a5e4e86-e5cc-41c9-9f15-30d94a27a514",
38 "nickname":"张三2",
39 "groupId":"aca4fa57-653f-4aa4-9c44-9b24e38cb172",
40 "groupName":"普通用户"
41 }
42 }
43 ]
44 }
45}订单详情
接口描述
本接口用于展示 AIPAGE 订单详情，返回查询的订单详细内容。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1GET /v{version}/order/{orderId} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| orderId | String | 是 | URL参数 | 订单id |
| siteId | String | 是 | query参数 | 站点 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回查询的订单详情 |
| success | Boolean | 返回是否操作成功 |
请求示例
Plain Text
1GET https://aipage.baidubce.com/v1/order/efabdd13-525f-4873-99aa-1e892ba8d52b
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4query: { siteId: "4aee2098-7c99-4253-9844-32194d25428e"}响应示例-1
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8"success": true,
9"result":{
10 "info":{},
11 "address":{},
12 "detail":{
13 "discount":"399.50",
14 "levelPoint":0,
15 "consumePoint":0
16 },
17 "id":"efabdd13-525f-4873-99aa-1e892ba8d52b",
18 "type":0,
19 "siteId":"4aee2098-7c99-4253-9844-32194d25428e",
20 "memberId":"f9b54dd3-5219-422c-92b1-e3888b5cb085",
21 "productId":"",
22 "status":3,
23 "purchasePrice":29950,
24 "fromPlatform":10,
25 "goodsType":1,
26 "logisticsCom":"",
27 "logisticsNum":"",
28 "remark":"",
29 "feedback":"",
30 "payAt":"1970-01-01T00:00:00.000Z",
31 "createdAt":"2021-06-04T07:10:27.000Z",
32 "updatedAt":"2021-06-04T07:16:52.000Z",
33 "deletedAt":"1970-01-01T00:00:00.000Z",
34 "orderDetail":[
35 {
36 "images":[
37 "/resources/upload/qianhu2/1585550059545.jpeg@wm_2,t_5rWL6K+V5rC05Y2w,ff_RmFuZ1Nvbmc=,sz_19,fc_4e35ccff,a_0,g_5"
38 ],
39 "id":"879d034e-4dec-42b4-9f18-8a00f0517832",
40 "goodsId":"e9d6c8a8-390b-4be3-82fa-8bd6390633b5",
41 "skuId":"",
42 "skuName":"",
43 "purchaseUnitPrice":29950,
44 "count":1,
45 "title":"冬季羽绒服-参数测试-虚拟订单",
46 "createdAt":"2021-06-04T07:10:27.000Z",
47 "updatedAt":"2021-06-04T07:10:27.000Z",
48 "deletedAt":"1970-01-01T00:00:00.000Z",
49 "orderId":"efabdd13-525f-4873-99aa-1e892ba8d52b"
50 }
51 ],
52 "member":{
53 "name":"手机用户-6344",
54 "id":"f9b54dd3-5219-422c-92b1-e3888b5cb085",
55 "nickname":"手机用户-6344",
56 "groupId":"aca4fa57-653f-4aa4-9c44-9b24e38cb872",
57 "groupName":"普通用户"
58 },
59 "isPaid":true,
60 "extras":[]
61}
62}物流查询
接口描述
本接口用于展示 AIPAGE 订单的物流详细信息。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1GET /v{version}/order/logistics HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| code | String | 是 | query参数 | 物流单号 |
| siteId | String | 是 | query参数 | 站点 ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 返回查询的物流详情 |
| success | Boolean | 返回是否操作成功 |
请求示例
Plain Text
1GET https://aipage.baidubce.com/v1/order/logistics
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4query: {code: '557043712624716', siteId: "4aee2098-7c99-4253-9844-32194d25428e"}响应示例-1
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true,
9 "result":{
10 "context":[
11 {
12 "time":"2021-03-04 13:31:58",
13 "datetime":"2021-03-04 13:31:58",
14 "desc":"您已在大连华润海中国四期133号楼店完成取件，感谢使用菜鸟驿站，期待再次为您服务。"
15 },
16 {
17 "time":"2021-02-27 14:35:41",
18 "datetime":"2021-02-27 14:35:41",
19 "desc":"到[通辽]"
20 },
21 {
22 "time":"2021-02-27 14:31:56",
23 "datetime":"2021-02-27 14:31:56",
24 "desc":"[通辽铁南分部]揽收成功"
25 }
26 ]
27 }
28}关闭订单
接口描述
本接口用于 AIPAGE 关闭订单只有待付款和待确认的两种状态的订单可以关闭。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/order/close HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| orderId | String | 是 | RequestBody参数 | 订单id |
| siteId | String | 是 | RequestBody参数 | 站点 ID |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 返回是否操作成功 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/order/close
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4query: { clientToken: '131323111'}
5Body: { orderId: "7f6bbe86-acc5-4fa9-975c-f2e422125125",
6 siteId: '4aee2098-7c99-4253-9844-32194d25428e',}响应示例-1
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success": true
9}删除订单
接口描述
本接口用于 AIPAGE 删除订单，注意物理删除不可恢复，只有已关闭和错误订单可以删除。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1DELETE /v{version}/order/:orderId HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| orderId | String | 是 | path参数 | 订单id |
| siteId | String | 是 | Query参数 | 站点 ID |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 返回是否操作成功 |
请求示例
Plain Text
1DELETE https://aipage.baidubce.com/v1/order/2137c261-b11e-4631-a65c-c12d3cfd7339
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4query: { clientToken: '131323111',siteId: '4aee2098-7c99-4253-9844-32194d25428e'}响应示例-1
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success": true
9}修改订单金额
接口描述
本接口用于 AIPAGE 修改订单金额，只有待付款和待确认的订单可以修改金额。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/order/updateMoney HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| orderId | String | 是 | RequestBody参数 | 订单id |
| price | String | 是 | RequestBody参数 | 订单价格以分为单位 |
| siteId | String | 是 | RequestBody参数 | 站点 ID |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 返回是否操作成功 |
| result | Array | 数组中返回金额变化的条数 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/order/updateMoney
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4query: { clientToken: '131323111'}
5Body: {purchasePrice: 18000,siteId: '4aee2098-7c99-4253-9844-32194d25428e',orderId:'2137c261-b11e-4631-a65c-c12d3cfd7339'}响应示例-1
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true,
9 "result":[
10 1
11 ]
12}确认收款
接口描述
本接口用于 AIPAGE 确认收款，只有待付款和待确认的订单可以确认收款。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/order/confirmMoney HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| orderId | String | 是 | RequestBody参数 | 订单id |
| siteId | String | 是 | RequestBody参数 | 站点 ID |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 返回是否操作成功 |
| result | Array | 数组中返回修改成功的条数 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/order/confirmMoney
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4query: { clientToken: '131323111'}
5Body: {status: 2,siteId: '4aee2098-7c99-4253-9844-32194d25428e',orderId:'2137c261-b11e-4631-a65c-c12d3cfd7339'}响应示例-1
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true,
9 "result":[
10 1
11 ]
12}发货
接口描述
本接口用于 AIPAGE 订单发货，只有订单状态为待发货的并且是普通商品可以发货。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/order/sendGoods HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| orderId | String | 是 | RequestBody参数 | 订单id |
| logisticsCom | String | 否 | RequestBody参数 | 物流公司 |
| logisticsNum | String | 是 | RequestBody参数 | 物流单号 |
| siteId | String | 是 | RequestBody参数 | 站点id |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 返回是否操作成功 |
| result | Array | 数组中返回修改成功的条数 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/order/sendGoods
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4query: { clientToken: '131323111'}
5Body: {orderId: '8c4b815e-0d8f-47a1-8f04-a617f0f0b869',logisticsCom: '韵达',logisticsNum:'111111111',siteId: '4aee2098-7c99-4253-9844-32194d25428e'}响应示例-1
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true,
9 "result":[
10 1
11 ]
12}预约订单核销
接口描述
本接口用于 AIPAGE 预约订单核销，通过此接口可以将预约状态改为已完成，注意：只有状态为待受理和受理中的订单可以核销。
注意事项
- authorization header 签名时必须签名 host 头部，同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1PUT /v{version}/appointment/:id HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| id | String | 是 | path参数 | 预约单id |
| siteId | String | 是 | body参数 | 站点 ID |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串，详见幂等性。 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 返回是否操作成功 |
请求示例
Plain Text
1PUT https://aipage.baidubce.com/v1/appointment/2137c261-b11e-4631-a65c-c12d3cfd7339
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4query: {clientToken: '131323111'}
5Body: {siteId: "4aee2098-7c99-4253-9844-32194d25428e"}响应示例-1
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "success":true
9}