Skip to content

Commit

Permalink
知晓云 OpenAPI 新增部署运营后台接口
Browse files Browse the repository at this point in the history
  • Loading branch information
zhanghengrui-ifanr committed Nov 3, 2022
1 parent bbc6de3 commit 73473a6
Show file tree
Hide file tree
Showing 3 changed files with 102 additions and 0 deletions.
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@
* [组集操作](open-api/group/super-group.md)
* [云函数](open-api/cloud-function.md)
* [短信服务](open-api/sms.md)
* [运营后台](open-api/user-dash.md)

----

Expand Down
1 change: 1 addition & 0 deletions open-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
* [用户模块](./user/README.md)
* [云函数](./cloud-function.md)
* [工具模块](./utils.md)
* [运营模块](./user-dash.md)
100 changes: 100 additions & 0 deletions open-api/user-dash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# 运营后台

## 部署运营后台

**接口**

`POST https://cloud.minapp.com/oserve/v2.6/miniapp/custom-userdash/`

**参数说明**

Content-Type: `application/json`

| 参数 | 类型 | 必填 | 说明 |
| :------------ | :----- | :-- | :-- |
| repository_path | String | N | 自定义管理后台部署压缩包地址,需要先调用上传文件接口获取文件上传成功后的访问地址 |
| url_refresh | String | N | 是否刷新管理后台部署地址,取值为:true or false,可为空,默认为 true |

**代码示例**

{% tabs getTokenV21Curl="Curl", getTokenV21Node="Node", getTokenV21PHP="PHP" %}

{% content "getTokenV21Curl"%}

```
curl -X POST \
-H "Authorization: Bearer 52ce223c5adbb66fa188a959a8b08889adb3580c" \
-H "Content-Type: application/json" \
-d '{
"repository_path":"https://baas-hello-world.cloud.ifanrusercontent.com/test.zip",
"url_refresh": true
}' \
https://cloud.minapp.com/oserve/v2.6/miniapp/custom-userdash/
```

{% content "getTokenV21Node"%}

```js
var request = require('request');

var opt = {
uri: 'https://cloud.minapp.com/oserve/v2.6/miniapp/custom-userdash/',
method: 'POST',
headers: {
Authorization: `Bearer ${token}`
},
json: {
repository_path: 'https://baas-hello-world.cloud.ifanrusercontent.com/test.zip',
url_refresh: 'true'
}
}

request(opt, function(err, res, body) {
console.log(res.statusCode, body)
})
```

{% content "getTokenV21PHP"%}

```php
<?php
$param = array(
'repository_path' =>'https://baas-hello-world.cloud.ifanrusercontent.com/test.zip',
'url_refresh'=> 'true'
);
$url = 'https://cloud.minapp.com/oserve/v2.6/miniapp/custom-userdash/';

$ch = curl_init();
$header = array(
"Authorization: Bearer {$token}",
'Content-Type: application/json; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$res['response'] = curl_exec($ch); // 反馈结果
$res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
curl_close($ch);
```

{% endtabs %}

**返回示例**

```json
{
"message": "Submit deploy request succeed.",
"status": "ok"
}
```

**状态码说明**

`200` 成功
`403` 套餐不符合或企业认证未完成

0 comments on commit 73473a6

Please sign in to comment.