总览

这是为 HR3内部开发者 准备的开发接口文档.

常用的一些信息

用户登入授权逻辑

1. 连接钱包, 获取钱包地址, 以钱包地址为参数, 获取用于该钱包签名的内容.
2. 唤起钱包对签名的内容进行签名, 获得签名结果.
3. 向后端的Auth API提交签名结果, 换取JWT.

API返回结果的格式

所有的API都遵循以下数据结构

{
    // code 只有在API调用成功的时候才会是0, 其他失败状况会有不同的数值
    "code":0,
    // API的调用消息用于在用户界面显示
    "msg":"API调用成功与否的消息或者失败的错误提示",
    // data 只有在API调用成功的时候才会有值
    "data":"",
}

API相关信息

测试环境 API Host: https://dev.hr3.io

正式环境 API Host: https://apiv1.hr3.io

提示

一个Endpoint由 Host + Scope + Path 组成,

比如用户获取签名内容的Endpoint 为 https://dev.hr3.io/auth/generate_sign_contents,

其中, Scope 为 auth, Path 为 generate_sign_contents.

HR3支持的Scope和Path

Scope	Path	说明
auth	generate_sign_contents	获取签名内容
---	wallet_sign_in	使用钱包登录
---	refresh	刷新JWT Token