开放平台是提供给开发者使用的平台。
适合阅读对象:开发者。
使用流程和访问新手开发者的主要使用流程是:
访问开放平台
假设配置的域名是 http://open.phalapi.net,那么管理后台的地址是:
http://open.phalapi.net/platform/
或者通过顶部的导航菜单,点击【开放平台】直接进入。
注册和登录注册开发者账号进入开发者注册页面,按提示填写注册信息,然后提交。
登录开放平台
注册成功后,进入开放平台登录页面,输入登录账号和密码,然后登录。
开放平台首页
在开放平台tudm,可以查看到概况统计、我的应用、我的订单、我的套餐、API总数、接口流量统计图表和表格数据、已提交的工单等概要信息。
应用管理创建我的应用
进入【应用管理】-【我的应用】-【创建新应用】,按要求填写相关信息,确认提交,然后等待管理员审核。
填写应用信息:
等待后台审核
创建新应用后等待管理员审核。
查看应用列表和信息
查看已经成功申请的应用密钥:
除了密钥,你还可以查看自己应用的其他信息,包括但不限于:
- 应用图标
- 应用名称
- 今日接口次数
- 接口限制次数(每天)
- 应用AppKey
- 有效日期(为空时表示不限制)
- 应用状态(正常使用/注销/禁用)
- 审核状态(待审核/已通过/未通过)
- 所属机构
应用审核通过后,可查看应用的接口权限。
接口权限在管理员分配接口权限后,就可以调用需要的开放接口API。
在 接口权限 页面,可以选择和切换自己的应用,搜索和查看 已获得的接口权限,或 未获得的接口权限,或全部接口。
对于未获得接口权限的接口,如需使用,需要和管理员申请权限。如果需要调用付费接口,可以在线立即购买。
调用OpenAPI开放接口
开发者在调用开放接口前,需要先注册开发者账号,创建新的应用并等待管理员审核通过,并且只能调用已分配权限的接口。
获取接口访问令牌首先,开发者需要根据已申请的 app_key 和 app_secret 创建新的访问令牌。可以使用接口App.Auth.ApplyToken 申请访问令牌接口。
界面化操作指引如下,进入在线接口文档,选择【App.Auth.ApplyToken】。
输入应用的app_key和密钥,获取令牌:
申请成功后,接口会返回access_token访问令牌,以及expire_at有效时间。
{ "ret": 200, "data": { "access_token": "访问令牌", "expire_at": 1580442248, "expire_time": "2022-08-31 14:13:51" }, "msg": "" }
对比三种获取令牌的方式:
请求具体的开放接口
接口
应用app_key
应用密钥
会员登录账号
会员登录密码
备注
App.Auth.ApplyToken
需要
需要
不需要
不需要
可指定uid,适合服务端调用
App.Auth.UserLogin
不需要
不需要
需要
需要
可指定app_key,适用客户端调用
App.Auth.AppUserLogin
需要
需要
需要
需要
自动绑定uid和app_key,适合客户端调用
接下来,就可以根据access_token访问令牌,访问其他的开放接口。
例如,调用 App.HelloWorld.HiApp 接口,curl请求报文是:
curl "http://你的域名/api/app.php?s=App.HelloWorld.HiApp&access_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiI1Yzc4MTQ0NyIsImF1ZCI6ImFwcCIsInN1YiI6IkRGUDdBVHNMdHN4cEpxbjRtOVZYMTFZIiwidWlkIjowLCJkaWQiOjM3LCJpYXQiOjE2NzAyNDg1NTgsImV4cCI6MTY3Mjg0MDU1OH0.pnpsPF6WK4lSvzuV2kMyF6T6W3iwsX1gn5THloJ9b-M"
得到的请求结果是:
{"ret":200,"data":{"content":"Hello app: DFP7ATsLtsxpJqn4m9VX11Y"},"msg":""}
需要注意的是,如果部分开放接口需要会员登录,此时开发者应使用App.User.UserLogin会员登录接口,根据会员登录账号、密码和app_key,生成一个带有会员登录态的访问令牌。
温馨提示:如果开放接口需要检测会员登录态,开发者应用需要调用App.User.UserLogin会员登录接口,生成访问令牌。
服务大厅在服务大厅,可以查看我的订单和已购买的接口服务。
我的订单在我的订单页面,可以查看订单列表,以及对未支付的订单,重新进行支付。
已购买的服务
对于已经购买的接口服务,可以查看已经使用消耗的接口次数,以及使用率。同时 可查看对应接口服务的有效时间。
购买接口服务和优惠套餐
你可以在前台的接口展示页面,通过购买入口进行购买,也可以在 开放平台 - 接口权限 - 更多优惠套餐,查看、选择和在线购买需要的优惠组合套餐。
开放平台更多功能介绍
根据平台界面菜单和提示,使用开放平台的其他功能模块。
工单管理如果在使用过程中,遇到问题、困难或需要,可以提交工单给后台人工处理。
创建新工单提交工单时,你可以提供以下重要信息:
- 工单标题
- 咨询模块
- 问题描述
- 你的手机号码
- 上传附件(最多5张图片)
创建新工单后,会有钉钉群/企业微信群通知新工单提醒,管理人员在收到工单后,会第一时间查看、响应和处理回复。
查看工单列表和回复可以查看过往的工单和回复情况,以及进行快速搜索。
统计
统计模块,主要提供了每日接口统计,支持日期范围、AppKey、API接口的搜索,图形展示,数据表格。
开发者资料
查看和修改开发者资料。
修改密码
英文版
你可以切换语言到英文版,也可以添加其他翻译语言。
,