提交 05aeaa49 编写于 作者: D DCloud_LXH

docs: server docs

上级 bd4f87c4
......@@ -60,4 +60,4 @@ DCloud会收取账单金额的15%做为服务费,然后将剩余款项支付
为了更好的服务插件作者,帮助插件作者节税,插件市场引入了`云账户`,参考[云账户介绍](https://ask.dcloud.net.cn/article/37525)
`Tips:`为了不影响收益打款,请插件作者在月初尽快提供发票,并完善[财务信息](https://dev.dcloud.net.cn/finance/detail)
\ No newline at end of file
`Tips:`为了不影响收益打款,请插件作者在月初尽快提供发票,并完善[财务信息](https://dev.dcloud.net.cn/#/pages/user/finance)
\ No newline at end of file
......@@ -2,8 +2,8 @@
- 登录[DCloud开发者中心](https://dev.dcloud.net.cn/),通过实名认证后,可通过以下入口进入UniPush的Web控制台进行配置
+ HBuilderX中打开项目的manifest.json文件,在“App模块配置”项的“Push(消息推送)”->“UniPush”下点击`配置`
![](https://native-res.dcloud.net.cn/images/uniapp/push/unipush-hx-config.png)
+ 登录[DCloud开发者中心](https://dev.dcloud.net.cn/),在“我创建的应用”列表中选择进入应用管理页面,点击左侧导航栏中的“Uni Push
![](https://native-res.dcloud.net.cn/images/uniapp/push/unipush-web-config.png)
+ 登录[DCloud开发者中心](https://dev.dcloud.net.cn/),在“我的应用”列表中选择进入应用管理页面,点击上方选项卡中的“uniPush”,然后点击“应用信息
![](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/unipush-web-config.png)
- 在UniPush开通界面配置“Android包名”、“Android应用签名”、“iOS Bundle Id”等信息,点击“开通”
- 开通后可进行其它消息推送参数配置
+ Android平台
......
......@@ -29,7 +29,7 @@ HBuilderX默认提供 `7` 个渠道(`Google`、`360`、`小米`、`华为`、
注意是根节点
```
```json
{
"channel_list":[
{
......@@ -42,7 +42,7 @@ HBuilderX默认提供 `7` 个渠道(`Google`、`360`、`小米`、`华为`、
比如:
```
```json
{
"channel_list":[
{
......@@ -61,7 +61,7 @@ HBuilderX默认提供 `7` 个渠道(`Google`、`360`、`小米`、`华为`、
## 离线打包的配置方法
下载最新的sdk,在Android项目的Androidmanifest.xml中的application节点下添加如下内容
```
```html
<meta-data android:name="DCLOUD_STREAMAPP_CHANNEL" android:value="{applicationId}|{appid}|{adid}|{channel}"/>
```
......@@ -72,7 +72,7 @@ android:value值由四个字段组成,使用‘|’符号分割,各字段说
- channel 渠道标识,**注意:提交谷歌应用市场(Google Play)时一定要将渠道标识设置为google**
例如:
```
```html
<meta-data
android:name="DCLOUD_STREAMAPP_CHANNEL"
android:value="io.dcloud.HBuilder|HBuilder|0123456789|google" />
......@@ -85,7 +85,7 @@ android:value值由四个字段组成,使用‘|’符号分割,各字段说
[推广渠道标识](http://www.html5plus.org/doc/zh_cn/runtime.html#plus.runtime.channel)
```
```js
plus.runtime.channel
```
......@@ -107,14 +107,14 @@ plus.runtime.channel
如果你的App不是uni-app,而是5+或wap2app。那么无法使用uni统计。此时可登录[DCloud开发者中心](http://dev.dcloud.net.cn)查看应用的基本统计数据。
首页会展示所有已创建的应用列表,点击应用名称可以查看该应用的『日活趋势』。
首页会展示所有已创建的应用列表,点击应用名称进入应用详情,点击可以『5+APP运营』查看该应用的『日活趋势』。
![](https://hx.dcloud.net.cn/static/snapshots/tutorial/android_channel_3.png)
![](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/applist.png)
包含渠道信息的应用,左上角选择渠道,即可查看对应渠道的运营统计数据。
![](https://hx.dcloud.net.cn/static/snapshots/tutorial/android_channel_4.png)
![](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/qudao.png)
**Tips:**
......
......@@ -13,7 +13,7 @@ keyword: 短信,sms
该服务类似小程序的模板消息,在一个固定模板格式的文字里自定义某些字段,而不是所有文字都可以随便写。
使用本功能需要在[DCloud开发者中心](https://dev.dcloud.net.cn/uniSms)开通并充值,教程参考[短信服务开通指南](https://ask.dcloud.net.cn/article/37534)
使用本功能需要在[DCloud开发者中心](https://dev.dcloud.net.cn/#/pages/sms/base)开通并充值,教程参考[短信服务开通指南](https://ask.dcloud.net.cn/article/37534)
因涉及费用,为保障安全,本能力应该在云函数中调用,而不是在前端调用。
......@@ -68,8 +68,8 @@ keyword: 短信,sms
报备模板的方式:
1. 如果尚未添加签名,请在在开发者中心-[签名配置](https://dev.dcloud.net.cn/uniSms/sign)内添加签名
2. 在开发者中心-[模板配置](https://dev.dcloud.net.cn/uniSms/tmp)内申请自定义模板
1. 如果尚未添加签名,请在在开发者中心-[签名配置](https://dev.dcloud.net.cn/#/pages/sms/sign)内添加签名
2. 在开发者中心-[模板配置](https://dev.dcloud.net.cn/#/pages/sms/template)内申请自定义模板
- 短信签名:
即短信内容开头的【xxx】,可选内容为App或小程序名称、网站名称、企业名称(可使用简称,但需具备辨识度)、商标名称。如`【DCloud】`,即是DCloud官方发送短信的签名。签名的作用是明确告知用户该短信由什么样的主体发送。签名内容只允许包含中文、英文、数字,签名的长度限制为2-8位。
......@@ -99,7 +99,7 @@ keyword: 短信,sms
接口调用失败时会直接抛出错误,调用成功时才会有返回值。
注意接口调用成功不代表短信发送成功,比如目标手机关机会导致短信发送失败。真实的短信发送成功与否请在[https://dev.dcloud.net.cn/uniSms](https://dev.dcloud.net.cn/uniSms)后台查看报表。
注意接口调用成功不代表短信发送成功,比如目标手机关机会导致短信发送失败。真实的短信发送成功与否请在[https://dev.dcloud.net.cn/#/pages/sms/base](https://dev.dcloud.net.cn/#/pages/sms/base)后台查看报表。
|参数名 |类型 |说明 |
|:-: |:-: |:-: |
......@@ -195,7 +195,7 @@ exports.main = async (event, context) => {
**注意事项**
- data内如果有`测试``test`等字样,系统可能会被判定为测试用途,不会真正把短信下发到对应手机(此行为由运营商控制,可能真实发送,也可能不发送)
-[DCloud开发者中心](https://dev.dcloud.net.cn/uniSms)绑定`uniCloud`服务空间后,将会只允许绑定的服务空间调用此接口,绑定列表为空时表示不限制服务空间
-[DCloud开发者中心](https://dev.dcloud.net.cn/#/pages/sms/base)绑定`uniCloud`服务空间后,将会只允许绑定的服务空间调用此接口,绑定列表为空时表示不限制服务空间
- 短信内容不可包含★、 ※、 →、 ●等特殊符号,可能会导致短信乱码
- 如果是用于用户注册的短信验证码,那么强烈推荐使用uni-id,这是一套云端一体的、完善的用户管理方案,已经内置封装好的短信验证码功能,详见:[uni-id-pages](uni-id-pages.md)
- 发送短信如果需要图形验证码来防止机刷,可以使用[uni-captcha图形验证码](https://ext.dcloud.net.cn/plugin?id=4048)。在[uni-id-pages](uni-id-pages.md)模板中已经集成了uni-id、uni-captcha
......
......@@ -1410,7 +1410,7 @@ module.exports = {
## 一键登录
一键登录是运营商提供的、比短信验证码更方便、更安全、更便宜的方案。[详见](https://uniapp.dcloud.net.cn/univerify)
- 使用本功能需要在[DCloud开发者中心 -> ](https://dev.dcloud.net.cn/uniLogin)开通并充值
- 使用本功能需要在[DCloud开发者中心 -> ](https://dev.dcloud.net.cn/#/pages/uniLogin/index)开通并充值
- 模块配置:`manifest.json`-->`App模块配置` -->`OAuth(登录鉴权)`-->` 一键登录`,点击后面的`开通配置`,在随后打开的web界面中,同意协议,并点击充值按钮充值。如只是测试,可以只充值1元钱。如果你已经确定包名,则可以在web界面点击“添加应用”,提交审核。这个是正式打包必须的。真机运行可以跳过此环节。记住页面上展示的`apiKey``apiSecret`,下一步需要用到。
- uni-id配置:`uni-id配置文件` --> `service` --> `univerify`,填写`appid``apiKey``apiSecret``appid`就是`manifest`里的`appid``apiKey``apiSecret`则是从上一步的web界面得来的。
......@@ -1428,7 +1428,7 @@ module.exports = {
## 短信验证码
为了方便开发调试,`uni-id-pages`未配置短信登录时,自动启动测试模式;直接使用:123456作为短信验证码即可。
- 使用本功能需要在[DCloud开发者中心 -> 短信验证码](https://dev.dcloud.net.cn/uniSms)开通并充值
- 使用本功能需要在[DCloud开发者中心 -> 短信验证码](https://dev.dcloud.net.cn/#/pages/sms/base)开通并充值
- 教程参考[短信服务开通指南](https://ask.dcloud.net.cn/article/37534)
- 密钥配置:`uni-id配置文件` --> `service` --> `sms` 填写相关密钥信息。
......
......@@ -183,7 +183,7 @@ uni-id的云端配置文件在`uniCloud/cloudfunctions/common/uni-config-center/
+ `tokenExpiresIn`token有效期,以秒为单位
+ `passwordErrorLimit`密码错误重试次数,分ip记录密码错误次数,达到重试次数之后等待`passwordErrorRetryTime`时间之后才可以重试
+ `passwordErrorRetryTime`单位为秒
+ 如果使用`sendSmsCode`接口发送短信需要前往[https://dev.dcloud.net.cn/uniSms](https://dev.dcloud.net.cn/uniSms)充值短信额度,配置`config.json``service`字段,字段说明见下方示例
+ 如果使用`sendSmsCode`接口发送短信需要前往[https://dev.dcloud.net.cn/#/pages/sms/base](https://dev.dcloud.net.cn/#/pages/sms/base)充值短信额度,配置`config.json``service`字段,字段说明见下方示例
+ 另外可以按照客户端平台进行不同的配置,参考下面示例
**下面的配置文件中所有时间的单位都是秒**
......@@ -268,7 +268,7 @@ uni-id的云端配置文件在`uniCloud/cloudfunctions/common/uni-config-center/
},
"univerify": {
"appid": "your appid", // 当前应用的appid,使用云函数URL化,此项必须配置
"apiKey": "your apiKey", // apiKey apiSecret 在开发者中心获取,开发者中心:https://dev.dcloud.net.cn/uniLogin/index?type=0,文档:https://ask.dcloud.net.cn/article/37965
"apiKey": "your apiKey", // apiKey apiSecret 在开发者中心获取,开发者中心:https://dev.dcloud.net.cn/#/pages/uniLogin/index,文档:https://ask.dcloud.net.cn/article/37965
"apiSecret": "your apiSecret"
}
}
......
......@@ -135,7 +135,7 @@ exports.main = async (event, context) => {
+ `tokenExpiresIn`token有效期,以秒为单位
+ `passwordErrorLimit`密码错误重试次数,分ip记录密码错误次数,达到重试次数之后等待`passwordErrorRetryTime`时间之后才可以重试
+ `passwordErrorRetryTime`单位为秒
+ 如果使用`sendSmsCode`接口发送短信需要前往[https://dev.dcloud.net.cn/uniSms](https://dev.dcloud.net.cn/uniSms)充值短信额度,配置`config.json``service`字段,字段说明见下方示例
+ 如果使用`sendSmsCode`接口发送短信需要前往[https://dev.dcloud.net.cn/#/pages/sms/base](https://dev.dcloud.net.cn/#/pages/sms/base)充值短信额度,配置`config.json``service`字段,字段说明见下方示例
+ 如果使用其他方式发送短信可以参考`sendSmsCode`接口的实现[uni-id sendSmsCode](https://gitee.com/dcloud/uni-id/blob/master/src/lib/verify/send-sms-code.js)
+ 另外可以按照客户端平台进行不同的配置,参考下面示例
......@@ -1417,7 +1417,7 @@ uni.removeStorageSync('uni_id_token_expired')
| type | String| 是 |类型,用于防止不同功能的验证码混用,目前支持的类型`login`登录、`register`注册、`bind`绑定手机、`unbind`解绑手机|
```
// 短信模板示例,请在https://dev.dcloud.net.cn/uniSms申请签名(短信开头中括号内部分)及模板
// 短信模板示例,请在https://dev.dcloud.net.cn/#/pages/sms/base申请签名(短信开头中括号内部分)及模板
验证码:${code},${expMinute}分钟内有效,请勿泄露并尽快验证。
```
......@@ -1590,7 +1590,7 @@ exports.main = async function(event,context) {
用法:`uniID.loginByUniverify(Object loginByUniverifyParams)`
> 需在[开发者控制台](https://dev.dcloud.net.cn/uniLogin)开通一键登录并在config.json内配置univerify相关信息
> 需在[开发者控制台](https://dev.dcloud.net.cn/#/pages/uniLogin/index)开通一键登录并在config.json内配置univerify相关信息
**参数说明**
......
......@@ -120,14 +120,14 @@ GitCode 仓库:[https://gitcode.net/dcloud/uni-starter](https://gitcode.net/dc
#### 在uni-app框架中配置:
在应用模块:`manifest.json` App模块配置 --> OAuth(登录鉴权)--> 勾选并配置你所需要的模块
+ 一键登录:
[开通配置](https://dev.dcloud.net.cn/uniLogin)
[开通配置](https://dev.dcloud.net.cn/#/pages/uniLogin/index)
[使用指南](https://uniapp.dcloud.io/univerify)
+ [苹果登录集成指南](https://ask.dcloud.net.cn/article/36651)
+ 短信登录:
>`uni-id-cf`文件路径:`/uniCloud-aliyun/cloudfunctions/uni-id-cf/index.js`
测试期间,为节约资源。统一虚拟短信验证码为:123456。正式使用注视掉`uni-id-cf`第339-344行即可
使用本功能需要在[DCloud开发者中心](https://dev.dcloud.net.cn/uniSms)开通并充值
使用本功能需要在[DCloud开发者中心](https://dev.dcloud.net.cn/#/pages/sms/base)开通并充值
教程参考[短信服务开通指南](https://ask.dcloud.net.cn/article/37534)
修改短信注册/登录发生验证码的模板id,在`uni-id-cf`搜索 `const templateId = '11753'` 替换为自己申请的模板id
......
......@@ -105,7 +105,7 @@ plus.push.getClientInfoAsync((info) => {
在【Uni Push】-【配置管理】-【故障排查】-【 状态查询】中输入CID 查询,看是否会返回 devicetoken 。
![img](https://native-res.dcloud.net.cn/images/uniapp/push/devicetoken1.png)
![img](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/devicetoken1.png)
**若返回 devicetoken :**
......@@ -119,7 +119,7 @@ plus.push.getClientInfoAsync((info) => {
- 检查后台是否有配置厂商参数(配置完参数需要云打包后生效)
![img](https://native-res.dcloud.net.cn/images/uniapp/push/devicetoken2.png)
![img](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/devicetoken2.png)
华为(包含荣耀)机型需要额外检查:
......@@ -148,13 +148,13 @@ plus.push.getClientInfoAsync((info) => {
**测试在线通知消息推荐您使用:**
![img](https://native-res.dcloud.net.cn/images/uniapp/push/send_notification.png)
![img](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/send_notification.png)
**测试离线通知消息推荐您使用:**
![img](https://native-res.dcloud.net.cn/images/uniapp/push/passthrough.png)
![img](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/passthrough.png)
......@@ -178,7 +178,7 @@ plus.push.getClientInfoAsync((info) => {
服务端集成时首先需要获取 AppId、AppKey、MasterSecret 参数,登录 [DCloud开发者中心](https://dev.dcloud.net.cn/) ,在“Uni Push”下的“应用配置”页面中获取,如下图所示:
![img](https://native-res.dcloud.net.cn/images/uniapp/push/app_config_info.png)
![img](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/app_config_info.png)
**Http 请求:**参数详情可查看:[服务端 RestAPI V2](https://docs.getui.com/getui/server/rest_v2/push/)
......
......@@ -131,23 +131,23 @@ uni-push产品有2个入口:
2. 通过开发者中心进入
使用 HBuilder 账号登录 [开发者中心](https://dev.dcloud.net.cn) ,登录后
会进入“我创建的应用”列表,如下图所示:
![](https://vkceyugu.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/51d70683-fef6-4990-a9a7-4d5d7cc10316.jpg)
点击要操作的应用的应用名称可进入应用管理页面,点击左侧导航中的“uniPush 2.0(支持全端推送)”-“应用信息”
会进入“我的应用”列表,如下图所示:
![](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/applist.png)
点击要操作的应用的应用名称可进入应用管理页面,点击上方选项卡中的“uniPush”-“Uni Push 2.0(支持全端推送)”-“应用信息”
以上两种方式均可进入uniPush 应用开通界面。如下图所示:
![](https://vkceyugu.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/637abb41-4702-4b05-928b-8aac6de7149f.jpg)
![](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/sfdh.png)
### 手机号验证
按照国家法律要求,所有提供云服务的公司在用户使用云服务时都需要验证手机号。
用户初次开通 uni-push 时,需要向个推同步手机号信息(DCloud开发者无需再注册个推账户)。
![](https://vkceyugu.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/a0e85961-e5e7-4e38-a6d0-aea6ab27766e.jpg)
![](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/sm.png)
### 填写应用信息
应用开通 uni-push 功能时,需要提交应用相关信息,如下图所示:
![](https://vkceyugu.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/381bd60a-a38b-412a-8bfb-6cafb9788a6a.jpg)
![](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/unipush.png)
关联服务空间说明:uni-push2.0需要开发者开通uniCloud。不管您的业务服务器是否使用uniCloud,但专业推送服务器在uniCloud上。
......@@ -168,9 +168,9 @@ uni-push产品有2个入口:
- iOS 平台还需要上传专用的推送证书
+ 证书申请:如何获取推送证书请参考个推官方文档教程 [iOS证书配置指南](https://docs.getui.com/getui/mobile/ios/apns/)
+ 证书上传入口:消息推送-“配置管理”-“应用配置”
![](https://vkceyugu.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/a75716f3-3541-48e0-a1cb-43de8308d2b5.jpg)
![](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/ios.png)
- APP手机厂商推送参数设置(可选,应用进程离线时推送通道)
![](https://vkceyugu.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/26656924-e58e-42dc-a5b2-6d72546aa5d2.jpg)
![](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/20220728173149.png)
uniPush集成并统一了各个手机厂商的系统级推送,目前支持魅族、OPPO、华为、小米、VIVO。如果需要使用厂商推送,需要先在各厂商开发者平台申请。详见[厂商推送应用创建配置流程](https://www.dcloud.io/docs/a/unipush/manufacturer.pdf)
......
......@@ -101,7 +101,7 @@
* 在开发者中心中填写华为AppID、华为AppSecret、应用包名、上传刚刚保存下的json文件。如下
![as_configuration3.png](https://native-res.dcloud.net.cn/images/uniapp/push/adnroid_vendor/dcloud_hw.png)
![as_configuration3.png](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/dcloud_hw.png)
## 二、 魅族应用创建配置流程
......@@ -132,7 +132,7 @@
* 在开发者中心中填写魅族AppID、魅族AppKey、魅族AppSecret:
![as_configuration2.png](https://native-res.dcloud.net.cn/images/uniapp/push/adnroid_vendor/dcloud_mz.png)
![as_configuration2.png](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/dcloud_mz.png)
## 三、 小米应用创建配置流程
......@@ -166,7 +166,7 @@
* 在开发者中心中填写小米AppID、小米AppSecret:
![as_configuration3.png](https://native-res.dcloud.net.cn/images/uniapp/push/adnroid_vendor/dcloud_xm.png)
![as_configuration3.png](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/dcloud_xm.png)
## 四、 OPPO应用创建配置流程
......@@ -191,7 +191,7 @@
### 2. 推送配置
* 在开发者中心中填写OPPO参数。
​ ![](https://native-res.dcloud.net.cn/images/uniapp/push/adnroid_vendor/dcloud_op.png)
​ ![](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/dcloud_op.png)
## 四、 VIVO应用创建配置流程
### 1. 创建应用
......@@ -215,5 +215,5 @@
### 2. 推送配置
* 在开发者中心中填写VIVO参数。
![](https://native-res.dcloud.net.cn/images/uniapp/push/adnroid_vendor/dcloud_vv.png)
![](https://img-cdn-aliyun.dcloud.net.cn/uni-app/doc/dev/dcloud_vv.png)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册