OAuth 接入文档
2024年8月26日约 405 字大约 1 分钟
相关信息
如果需要申请 OAuth 接口,请联系 hestudio@hestudio.net
第三方App申请OAuth接口,每个需要接入OAuth登录的App都需要申请OAuth Secret
包括:
• 显示名称(声明APP名称)
• 显示主体名称(不必与认证主体相同)
• 显示图标(推荐svg或者webp,其他图片格式转换成webp)
• 描述(可选),用于说明功能
• 申请人的heStudio Account UserID
• 可信域名
面向个人用户,需要主体运营人的身份证正反面,主体运营人正面照一张。面向企业用户,需要主体营业执照,营业执照法人身份证正反面和法人正面照一张。
API 接口
https://apifox.com/apidoc/shared-1a29ea2d-4187-4ee0-b0c3-d2aadc09b854
体验 Secret(请勿用于正式环境)
d4112c01ec6d54d162dcbabd0fc1639381da0bb94647541b3f7694fffce4751f
登录流程(仅供参考)
创建登录
- 用户触发登录,通知主体服务器,由主体服务器带 OAuth Secret 向
https://api.hestudio.net/account/oauth/create
发送 POST 请求 - heStudio API 服务器会返回一个空白 OAuth Token
- 用户端跳转到
https://account.hestudio.net/login/oauth/?otoken=${OAuth_Token}
,其中 ${OAuth_Token} 应替换为返回的空白 OAuth Token - 完成登录流程
验证登录
主体需要通过验证登录判断用户是否已经登录和登录是否存续,流程如下:
- 主体后端携带 Secret 将 OAuth Token 提交到
https://api.hestudio.net/account/oauth/verify
(POST)请求 - 状态返回统一返回 true 或者 false
穿戴设备登录方案
App 生成跳转到 https://account.hestudio.net/login/oauth/?otoken=${OAuth_Token}
的二维码,用户扫码验证登录。其他步骤保持不变