On this page
2. 数字身份
数字身份和数字头像使用的是相同的接口,通过请求参数中的type进行区分
接入要求
1、数字身份支持 GET 请求方式,不支持分页
2、接⼝可使⽤ curl 访问
3、图⽚需要可使⽤提供的地址访问,且必须为 https,否则可能会造成图⽚显示异常
4、若您的地址有防⽕墙,请将以下IP加入白名单中:
101.132.77.44 101.132.122.106 101.132.122.49
106.15.91.193 139.196.124.185 120.55.190.164
47.100.240.73 47.100.1.155 47.100.54.9 47.101.31.59
139.224.235.230
接入样式
图1:数字身份接入后,会在数字身份的首页展示所有已接入的平台方
图2:用户持有的所有数字身份会展示在数字身份列表中,可以任意选择数字身份使用
图3&图4:用户使用数字身份后,用户个人中心会换为该数字身份,在社区中发布的动态、评论等内容也会显示该数字身份
请求字段
我们将使用如下字段对您发起请求
例如:https://yourdomain?userAuth=13888888888&type=DID&classify=.d
注意:数字身份和数字头像使用的是相同的接口,通过请求参数中的type进行区分
参数 | 类型 | 描述 |
---|---|---|
userAuth | String | 通过该参数获取用户已有的数字身份,必填,目前支持手机号和地址两种方式(二选一),可在盯链开放平台后台配置接口时选择 若为手机号导入,则参数为手机号,例如:13888888888 若为地址导入,则该参数为链上地址,例如:0x980e5DD186eB72c92565F93817cB858AE522633f |
type | String | 查询类型,默认参数值为DID,表示查询数字身份 |
classify | String | 通过该参数获取用户数字身份的顶级域名,必填 例如:userAuth参数为13888888888,classify参数为.d,表示查询13888888888这个用户账号中所有.d的域名 |
响应字段
参数 | 类型 | 描述 |
---|---|---|
err | boolean | 是否异常的标识,若有异常,则返回true,若无异常,则返回false |
msg | string | 当出现错误时,显示在前端的错误信息 |
data | Array<Result> | 业务数据,响应成功时,返回用户的所有数字身份 |
响应成功后,data中的每一块数据需要包含以下参数:
参数 | 类型 | 描述 |
---|---|---|
domain | String | 二级域名前缀,必填,例如:域名为123.d,则此字段值为123 |
classify | String | 顶级域名的类别,必填,例如:域名为123.d,则此字段值为.d |
image | String | 数字身份对应的图片地址,必填 图⽚需要可使⽤提供的地址访问,且必须为 https,否则可能会造成图⽚显示异常 |
gotAt | Long | 用户获取时间 (毫秒级时间戳) |
响应示例(成功)
请使用以下示例给出的结构返回
JSON
{
"err": false,
"data": [
{
"domain": "usb",
"classify": ".vip",
"image": "https://yourdomain.com/did/usb.jpg",
"gotAt": 1672502400000
},
{
"domain": "6902",
"classify": ".vip",
"image": "https://yourdomain.com/did/6902.jpg",
"gotAt": 1672502400000
}
]
}
以下为响应成功后各参数在APP中的展示位置
响应示例(失败)
响应失败后,我们会将错误信息以toast的形式展示给用户
JSON
{
"err": true,
"msg": "用户不存在" // 错误原因
}