跳转至

区块链认证 API

Auth API 是一个在使用 Hive 区块链 API 时发放身份验证所需令牌的 API。

认证令牌发放

这是一个发放身份验证令牌的API,使用区块链服务API时需要这些令牌。

请求 URL

直播网址 https://bc-platform-auth.withhive.com/v2/auth-token
沙盒网址 https://sandbox-bc-platform-auth.withhive.com/v2/auth-token
HTTP 方法 POST
内容类型 application/json

请求体

字段名称 描述 类型 必需
id 获取认证令牌的ID 字符串
secretKey API使用所需的密钥 字符串

响应

字段名称 描述 类型
code API调用结果代码,0:成功 number
message 结果消息 string
data API响应值 json
data.accessToken API使用所需的身份验证令牌 string
data.refreshToken 可用于在accessToken过期时续订的令牌 string

请求示例

curl -X 'POST' 
  'https://sandbox-bc-platform-auth.withhive.com/v2/auth-token' 
  -H 'accept: */*' 
  -H 'Content-Type: application/json' 
  -d '{
  "id": "test",
  "secretKey": "1234"
}'

响应示例

{
  "code": 0,
  "message": "success",
  "data": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNvbS5jb20ydXMuYzJ4d2FsbGV0Lmdsb2JhbC5ub3JtYWwiLCJyb2xlIjoib3BlcmF0b3IiLCJhZGRyZXNzIjoieHBsYTE5cHdkYTJsdXQ5eGFlZnI4Z3NtZ2t0dXFldzkwc2M1YWpseGhrZyIsImlhdCI6MTY2NzM4MjY5NSwiZXhwIjoxNjY3NDY5MDk1fQ.xRq3ew5GAcn0zEcTEyRAXByjAbhgRQb3aWqaxy_iQ68",
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNvbS5jb20ydXMuYzJ4d2FsbGV0Lmdsb2JhbC5ub3JtYWwiLCJyb2xlIjoib3BlcmF0b3IiLCJhZGRyZXNzIjoieHBsYTE5cHdkYTJsdXQ5eGFlZnI4Z3NtZ2t0dXFldzkwc2M1YWpseGhrZyIsImlhdCI6MTY2NzM4MjY5NSwiZXhwIjoxNjY3OTg3NDk1fQ.s8dL3tCwdbHUTQnWqAWbDSaGumKF3Jc_aYXVJUp1VxQ"
  }
}

令牌重新发行

这是发放身份验证令牌的API,该令牌在身份验证令牌过期时使用与身份验证令牌一起收到的刷新令牌来使用Hive区块链API。

请求 URL

直播网址 https://bc-platform-auth.withhive.com/v2/refresh-token
沙盒网址 https://sandbox-bc-platform-auth.withhive.com/v2/refresh-token
HTTP 方法 POST
内容类型 application/json

请求头

字段名称 描述 类型 必需
Authorization API 调用所需的 refreshToken 字符串

响应

字段名称 描述 类型
code API调用结果代码,0:成功 number
message 结果消息 string
data API响应值 json
data.accessToken API使用所需的认证令牌 string
data.refreshToken 当accessToken过期时可用于续订的令牌 string

请求示例

curl -X 'POST' 
  'https://test-bc-platform-auth.withhive.com/v2/refresh-token' 
  -H 'accept: */*' 
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXlObyI6MSwiaWQiO...' 
  -d ''

响应示例

{
  "code": 1000,
  "message": "success",
  "data": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNvbS5jb20ydXMuYzJ4d2FsbGV0Lmdsb2JhbC5ub3JtYWwiLCJyb2xlIjoib3BlcmF0b3IiLCJhZGRyZXNzIjoieHBsYTE5cHdkYTJsdXQ5eGFlZnI4Z3NtZ2t0dXFldzkwc2M1YWpseGhrZyIsImlhdCI6MTY2NzQ3MTIwMSwiZXhwIjoxNjY3NTU3NjAxfQ.icFnROeEU7RI0FvEdPR5Oa26YqEihwcBN-KT_n_iq_o",
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNvbS5jb20ydXMuYzJ4d2FsbGV0Lmdsb2JhbC5ub3JtYWwiLCJyb2xlIjoib3BlcmF0b3IiLCJhZGRyZXNzIjoieHBsYTE5cHdkYTJsdXQ5eGFlZnI4Z3NtZ2t0dXFldzkwc2M1YWpseGhrZyIsImlhdCI6MTY2NzQ3MTIwMSwiZXhwIjoxNjY4MDc2MDAxfQ.fclh8qVxLRG0Z1Fn2KRtW7Dmm6KFY5H4jvRSroy-mag"
  }
}