Files
phalapi-pro/public/wiki/platform.md
2022-03-21 11:16:38 +08:00

113 lines
4.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Platform开放平台使用手册
开放平台是提供给开发者使用的平台。
新手开发者的主要使用流程是:
![](http://cdn7.okayapi.com/yesyesapi_20200411123116_53fe0dfe07c90ac558a17e504abef8ed.png)
## 访问开放平台
假设配置的域名是http://open.phalapi.net那么管理后台的地址是
```
http://open.phalapi.net/platform/
```
或者通过在线接口文档页面,点击【开放平台】直接进入,例如:
![](http://cdn7.okayapi.com/yesyesapi_20200409173653_65a7dd71ba162003647b95ecd13b0231.png)
## 注册开发者账号
进入开发者注册页面,按提示填写注册信息,然后提交。
![](http://cdn7.okayapi.com/yesyesapi_20200413122310_bde655db95443a799fa78f623a25e141.png)
## 登录开放平台
注册成功后,进入开放平台登录页面,输入登录账号和密码,然后登录。
![](http://cdn7.okayapi.com/yesyesapi_20200426161752_4039d1c4fedce6bc6e60a47b36178730.jpg)
## 创建应用
进入【应用管理】-【我的应用】-【创建新应用】,按要求填写相关信息,确认提交,然后等待管理员审核。
![](http://cdn7.okayapi.com/yesyesapi_20200426163424_37de2dc9739f8326c5fe9c3a8736c9ab.png)
填写应用信息:
![](http://cdn7.okayapi.com/yesyesapi_20200426163554_05291a7ed07388b769d9ca0683591ee6.png)
创建新应用后等待管理员审核。
![](http://cdn7.okayapi.com/yesyesapi_20200426163633_7826f5e704b696488a48a5ad143f8a60.png)
查看应用密钥:
![](http://cdn7.okayapi.com/yesyesapi_20200426163706_7d1b1143519b17df92ea981fea873248.png)
应用审核通过后,可查看应用的接口权限。
## 查看接口权限
在管理员分配接口权限后就可以调用需要的开放接口API。
![](http://cdn7.okayapi.com/yesyesapi_20200426163845_57a2563bf6eed3481ab95cf021dc328c.png)
## 调用开放接口
开发者在调用开放接口前,需要先注册开发者账号,创建新的应用并等待管理员审核通过,并且只能调用已分配权限的接口。
## 获取接口访问令牌
首先开发者需要根据已申请的app_key和app_secret创建新的访问令牌。可以使用接口**App.Auth.ApplyToken** 申请访问令牌接口。
界面化操作指引如下进入在线接口文档选择【App.Auth.ApplyToken】。
![](http://cdn7.okayapi.com/yesyesapi_20200413123154_cfac048c85259a010bd5a69cca7eab5d.png)
输入应用的app_key和密钥获取令牌
![](http://cdn7.okayapi.com/yesyesapi_20200413123334_6f24af3d061f7ee072c92b66230c76cc.png)
申请成功后接口会返回access_token访问令牌以及expire_at有效时间。
```
{
"ret": 200,
"data": {
"access_token": "访问令牌",
"expire_at": 1580442248
},
"msg": ""
}
```
对比三种获取令牌的方式:
接口|应用app_key|应用密钥|会员登录账号|会员登录密码|备注
---|---|---|---|---|---
App.Auth.ApplyToken|需要|需要|不需要|不需要|可指定uid
App.Auth.UserLogin|不需要|不需要|需要|需要|可指定app_key
App.Auth.AppUserLogin|需要|需要|需要|需要|自动绑定uid和app_key
### 调用开放接口
接下来就可以根据access_token访问令牌访问其他的开放接口。
需要注意的是,如果部分开放接口需要会员登录,此时开发者应使用**App.User.UserLogin**会员登录接口根据会员登录账号、密码和app_key生成一个带有会员登录态的访问令牌。
> 温馨提示:如果开放接口需要检测会员登录态,开发者应用需要调用**App.User.UserLogin**会员登录接口,生成访问令牌。
## 使用开放平台
根据平台界面菜单和提示,使用开放平台的其他功能模块。
### 开发者资料
查看和修改开发者资料。
![](http://cdn7.okayapi.com/yesyesapi_20200426164000_a25922bda2fb74ac2669fe3c2da3fa74.png)
![](http://cdn7.okayapi.com/yesyesapi_20200426164102_cf6d5f77ebdc900989265102d40a68f2.png)
### 修改密码
![](http://cdn7.okayapi.com/yesyesapi_20200426164139_66f617cb6909ba0722393ac53f9016e3.png)
## 英文版
你可以切换语言到英文版,也可以添加其他翻译语言。
![](http://cdn7.okayapi.com/yesyesapi_20200426165811_1a3b5b93c6389a68727ff88af9dcedc1.png)