一、账号授权登录API

此API用于使用账号及Api key获取登录权限信息

二、调用方法

API URL:https://higateway.haishuu.com/gateway/hi-auth-api/v1/account-auth
请求方式:POST
接口状态:正常

2.1 请求参数

名称 位置 类型 是否必填 描述
hi-api-key header String 访问接口的权限key
字段 名称 类型 是否必填 描述
account 账号 String 嗨数云账号
curl --request POST \
  --url https://higateway.haishuu.com/gateway/hi-auth-api/v1/account-auth \
  --header 'Content-Type: application/json' \
  --header 'hi-api-key: #K-xxx' \
  --data '{
    "account": "xxx"
}'

2.2 返回参数

字段 名称 类型 描述
status 接口响应状态码 integer 成功=200
code 业务响应编码 String 成功=0
message 业务响应描述 String 操作成功
success 接口成功标记 boolean true 成功, false 失败
data 返回数据 Object
字段 名称 类型 描述
accessToken 授权Token String 登录授权的认证信息
jumpUrl 跳转地址 String 认证成功免登陆跳转地址
{
    "status": 200,
    "code": "0",
    "message": "操作成功",
    "success": true,
    "data": {
        "accessToken": "ayJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJpc3N1c2VyIiwiYXVkIjoiYXVkaWVuY2UiLCJyb2xlX25hbWUiOiIiLCJ0ZW5hbnRfaWQiOiJoODYxODQ4IiwidXNlcl9pZCI6IjE4MDYyMzM1OTAyMTMzNjE2NjYiLCJyb2xlX2lkIjoiIiwidXNlcl9uYW1lIjoidGVzdDAwMiIsInRva2VuX3R5cGUiOiJhY2Nlc3NfdG9rZW4iLCJhY2NvdW50IjoidGVzdDAwMiIsImV4cCI6MTcyODcxNzQ2MywibmJmIjoxNzI4NjMxMDUzfQ.dMV4KQAXb2FNR7Kd0U6ys9r_z-82mlDoawXJSYAdXMxCtafTA2shrNMDIA_9lLWWRHZ89HmQ47BH9ZI0eSdrcw",
        "jumpUrl": "https://hicloud.haishuu.com?token=ayJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJpc3N1c2VyIiwiYXVkIjoiYXVkaWVuY2UiLCJyb2xlX25hbWUiOiIiLCJ0ZW5hbnRfaWQiOiJoODYxODQ4IiwidXNlcl9pZCI6IjE4MDYyMzM1OTAyMTMzNjE2NjYiLCJyb2xlX2lkIjoiIiwidXNlcl9uYW1lIjoidGVzdDAwMiIsInRva2VuX3R5cGUiOiJhY2Nlc3NfdG9rZW4iLCJhY2NvdW50IjoidGVzdDAwMiIsImV4cCI6MTcyODcxNzQ2MywibmJmIjoxNzI4NjMxMDUzfQ.dMV4KQAXb2FNR7Kd0U6ys9r_z-82mlDoawXJSYAdXMxCtafTA2shrNMDIA_9lLWWRHZ89HmQ47BH9ZI0eSdrcw"
    }
}

三、错误码

接口响应状态码 接口响应状态码描述 业务响应编码 业务响应编码描述
200 成功 0 成功
5001 业务异常 API_KEY_EXPIRED API_KEY已过期
5001 业务异常 NOT_IN_IP_WHITE_LIST IP白名单限制
5001 业务异常 API_KEY_NOT_EXISTED API_KEY不存在
5001 业务异常 LOGIN_BY_FAIL 登录失败
5001 业务异常 ACCOUNT_NOT_EXISTED 账号不存在
5001 业务异常 ACCOUNT_UNAUTHORIZED 账户未授权
5001 业务异常 ACCOUNT_NO_COLLABORATOR 该账户不存在协作者关系
5001 业务异常 ACCOUNT_DEACTIVATE 账号暂不能正常使用,请联系相关对接人或联系客服
6001 参数验证异常 PARAM_IS_EMPTY 参数为空
{
    "status": 5001,
    "code": "API_KEY_EXPIRED",
    "message": "API_KEY已过期",
    "success": false,
    "data": null
}
{
    "status": 5001,
    "code": "NOT_IN_IP_WHITE_LIST",
    "message": "IP白名单限制 [172.23.7.64]",
    "success": false,
    "data": null
}
{
    "status": 6001,
    "code": "PARAM_IS_EMPTY",
    "message": "参数验证异常",
    "success": false,
    "data": null
}

四、限制

类型 调用限制 描述
普通用户 QPS:5次/秒 接口限制
作者:超级管理员  创建时间:2024-10-11 15:07
最后编辑:超级管理员  更新时间:2024-10-17 17:28