• 接口文档
    • 1. 新增用户接口
      • 接口描述
      • 接口URL
      • 响应参数
    • 2. 查询用户接口
      • 接口描述
      • 接口URL
      • 调用方法
    • 请求参数
    • 响应参数
    • 附录
      • 返回码信息列表

    接口文档

    1. 新增用户接口

    接口描述

    新增用户。

    接口URL

    http://localhost:8085/WeBASE-Sign/user/newUser

    响应参数

    1）参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString是返回码信息请附录1
    2提示信息messageString是
    3返回数据dataObject是
    3.1用户编号userIdInteger是
    3.2私钥信息privateKeyString是
    3.3账户地址addressString是
    3.4公钥publicKeyString是
    3.5描述descriptionString是

    2）数据格式

    a.请求正常返回结果

    1. {
    2.     "code": 0,
    3.     "message": "success",
    4.     "data": {
    5.         "userId": 100011,
    6.         "address": "0xaf7f9ad9560aa7cde37c693ba373707ab31d7823",
    7.         "publicKey": "0x6efc55a03436057c4181160c195581e4f6b8a2135ea1030a326d5339a4f4a2a9bf2d603e020c77fa5b52af109f18955747bd0bcfa249955707d3932b544a9c65",
    8.         "privateKey": "d3d8583b27bc5be0bca0ffb9d53db5a3324585148cd88e629a0b1084d2755bc8",
    9.         "description": null
    10.     }
    11. }

    b.异常返回结果示例（信息详情请参看附录1）

    1. {
    2.   "code": 103001,
    3.   "message": "system error",
    4.   "data": null
    5. }

    2. 查询用户接口

    接口描述

    根据用户名查询用户信息。

    接口URL

    http://localhost:8085/WeBASE-Sign/user/{userAddress}/userInfo

    调用方法

    HTTP GET

    请求参数

    1）参数表

    序号中文参数名类型最大长度必填说明
    1用户地址userAddressString32是

    2）数据格式

    http://localhost:8085/WeBASE-Sign/user/0xaf7f9ad9560aa7cde37c693ba373707ab31d7823/userInfo

    响应参数

    1）参数表

    序号中文参数名类型最大长度必填说明
    1返回码codeString是返回码信息请附录1
    2提示信息messageString是
    3返回数据dataObject是
    3.1用户编号userIdInteger是
    3.2用户私钥privateKeyString是
    3.3账户地址addressString是链上地址
    3.4公钥publicKeyString是
    3.5描述descriptionString是

    2）数据格式

    a.请求正常返回结果

    1. {
    2.     "code": 0,
    3.     "message": "success",
    4.     "data": {
    5.         "userId": 100011,
    6.         "address": "0xaf7f9ad9560aa7cde37c693ba373707ab31d7823",
    7.         "publicKey": "0x6efc55a03436057c4181160c195581e4f6b8a2135ea1030a326d5339a4f4a2a9bf2d603e020c77fa5b52af109f18955747bd0bcfa249955707d3932b544a9c65",
    8.         "privateKey": "d3d8583b27bc5be0bca0ffb9d53db5a3324585148cd88e629a0b1084d2755bc8",
    9.         "description": null
    10.     }
    11. }

    b.异常返回结果示例（信息详情请参看附录1）

    1. {
    2.   "code": 103001,
    3.   "message": "system error",
    4.   "data": null
    5. }

    附录

    返回码信息列表

    Codemessage描述
    0success正常
    103001system error系统异常
    203003param valid fail参数校验异常
    303001user is already exists用户已存在
    303002user does not exist用户不存在
    303003privateKey is null用户私钥为空
    303004privateKey decode fail私钥解码失败
    303006address is null用户地址为空