授权 #

准备工作 #

盯链授权登录是基于OAuth2.0 协议标准构建的 OAuth2.0 授权登录系统。 在进行 OAuth2.0 授权登录接入之前，在盯链平台注册开发者帐号，并拥有一个已审核通过的应用，并获得相应的 AppID 和 AppSecret，可开始接入流程。

授权流程说明 #

OAuth2.0 授权登录让用户使用 盯链APP 安全登录第三方应用或网站，在用户授权登录已接入 盯链APP OAuth2.0 的第三方应用后，第三方可以获取到用户的接口调用凭证access_token，通过access_token可以进行盯链开放平台授权关系接口调用，从而可实现获取 盯链 用户基本开放信息和帮助用户实现基础开放功能等。

盯链APP OAuth2.0 授权登录目前支持 authorization_code 模式，适用于拥有 server 端的应用授权。该模式整体流程为：

1. 第三方应用发起钱包授权登录，根据授权请求参数跳转至 盯链APP 授权页面
2. 盯链APP 用户允许授权第三方应用后，会重定向回到第三方网站，并且带上授权临时票据code参数
3. 通过 code 获取 access_token
4. 通过 access_token 进行接口调用，获取用户基本数据资源或帮助用户实现基本操作

获取 access_token 时序图：

第一步 获取 code #

H5 网页授权 #

若为APP，请跳转浏览器并打开以下地址：

若为H5，请重定向至以下地址：

https://auth.h5.dinglian.biz/loading?appid=APPID&chain_id=CHAINID&scope=SCOPE&redirect_uri=REDIRECT_URI&type=oauth&state=STATE&phone_number=PHONE_NUMBER&restricted=RESTRICTED

以上地址中的参数需要平台完成拼接

参数说明 #

返回说明 #

当用户点击“允许”授权后，授权页面会通过传入的 redirect_uri 进行重定向请求

redirect_uri?code=CODE&state=STATE

第二步 通过 code 获取 access_token #

• 请求 #

通过 code 获取 access_token:

https://api.dingstock.top/xserver/oauth2/access_token?appid=APPID&secret=SECRET&code=CODE

参数说明 #

• 响应 #

{
  "res": {
    "access_token": "ACCESS_TOKEN",
    "expires_in": 7200,
    "refresh_token": "REFRESH_TOKEN",
    "openid": "OPENID",
    "scope": "SCOPE"
  },
  "code": 200
}

参数说明 #

错误返回样例：

{
  "msg": "invalid scope",
  "code": 500 // 错误码
}

第三步 通过 access_token 获取用户信息 #

获取 access_token 后，进行接口调用，有以下前提：

1. access_token 有效且未超时；
2. 用户已授权给第三方应用帐号相应作用域（scope）。

此接口用于获取用户个人信息。开发者可通过 openid 来获取用户基本信息。

• 请求 GET #

https://api.dingstock.top/xserver/oauth2/userinfo?access_token=ACCESS_TOKEN&openid=OPENID&scope=SCOPE

参数说明 #

• 响应 #

  响应的数据由用户对第三方应用授权时的 scope 参数和请求参数中的 scope 决定，scope 作用域详见授权 scope。

其中，contact对应用户手机号信息敏感字段，返回结果会进行 AES 加密，AES 密钥为 appsecret 在盯链开放平台中获取。

{
  "res": {
    // scope含baseInfo时返回
    "baseInfo": {
      "openid": "OPENID",
      "walletAddress": "0x111111111111111111",
      "chainId": "conflux",
      "nickName": "昵称",
      "authLevel": 0
    },
    // scope含contact时返回
    "contact": {
      "phoneNumber": "AES(手机号)" // 通过 appsecret 解密
    }
  },
  "code": 200
}

刷新 access_token #

access_token 是调用授权关系接口的调用凭证，由于 access_token 有效期（目前为 2 个小时）较短，当 access_token 超时后，可以使用 refresh_token 进行刷新。

• 请求 #

  请求以下链接进行 refresh_token：

https://api.dingstock.top/xserver/oauth2/refresh_token?appid=APPID&refresh_token=REFRESH_TOKEN

参数说明 #

• 响应 #

{
  "access_token": "ACCESS_TOKEN",
  "expires_in": 7200,
  "refresh_token": "REFRESH_TOKEN",
  "openid": "OPENID",
  "scope": "SCOPE"
}

响应参数及错误情况同上

授权 Scope #

baseInfo #

支持链 #

conflux #

接入样式 #