跳转到内容

获取账号信息接口

合作商可通过 API 密钥获取当前密钥对应用户的账号基础信息、账户余额和受信余额。

请求信息

项目说明
请求地址/partner/GetUserData/
请求方式POST
Content-Typeapplication/jsonapplication/x-www-form-urlencoded

请求参数

参数类型必填说明
apikeystringAPI 密钥。推荐传 app_id:api_secret,也兼容仅传 api_secret

也可以使用请求头传入:

Header说明
X-API-Keyapikey 参数含义相同。
Authorization支持 Bearer {apikey}

请求示例

json
{
  "apikey": "ak_xxxxxxxxxxxxxxxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

响应参数

参数类型说明
codeinteger业务状态码,200 表示成功。
messagestring响应消息。
data.userobject用户基础信息。
data.accountobject用户账户余额信息。
data.api_keyobject本次鉴权使用的 API Key 信息,不包含 Secret。
data.server_timestring服务器响应时间。

用户基础信息

参数类型说明
idinteger用户自增 ID。
user_idstring用户业务 ID。
usernamestring用户名。
statusinteger用户状态:0 已封禁,1 正常,2 等待邮箱核验,3 等待手机核验。
status_textstring用户状态说明。
user_typestring用户类型,如 userpartneradmin
partner_levelinteger合作商等级。
bound_phonestring/null用户绑定手机号。
bound_emailstring/null用户绑定邮箱。

账户信息

参数类型说明
balancenumber用户账户余额。
credit_linenumber受信额度。
credit_usednumber已使用受信额度。
credit_availablenumber可用受信额度。
trusted_balancenumber受信余额,同 credit_available
total_availablenumber可用总额,等于账户余额加可用受信额度。

API Key 信息

参数类型说明
app_idstring/nullAPI Key 的 AppID。
last_used_ipstring/null本次调用来源 IP。

响应示例

json
{
  "code": 200,
  "message": "ok",
  "data": {
    "user": {
      "id": 1,
      "user_id": "1",
      "username": "partner",
      "status": 1,
      "status_text": "正常",
      "user_type": "partner",
      "partner_level": 1,
      "bound_phone": "18600000000",
      "bound_email": "partner@example.com"
    },
    "account": {
      "balance": 1000,
      "credit_line": 500,
      "credit_used": 100,
      "credit_available": 400,
      "trusted_balance": 400,
      "total_available": 1400
    },
    "api_key": {
      "app_id": "ak_xxxxxxxxxxxxxxxxxxxxxxxx",
      "last_used_ip": "203.0.113.10"
    },
    "server_time": "2026-07-04 14:30:00"
  }
}

错误码

code说明
400请求参数错误,或缺少 apikey
401API 密钥无效。
403API 密钥关闭、吊销、过期,IP 不在白名单内,或账号被封禁。
405请求方式错误。
500服务器错误。

EveryoneTrust SSL 文档中心,帮助你稳定完成 HTTPS 运维。