跳轉至

Hive blockchain auth api

身份驗證 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 字串 Y
secretKey API 使用所需的密鑰 字串 Y

回應

欄位名稱 描述 類型
code API 呼叫結果代碼,0: 成功 數字
message 結果訊息 字串
data API 回應值 json
data.accessToken 用於 API 使用的身份驗證令牌 字串
data.refreshToken 當 accessToken 到期時可用於更新 accessToken 的令牌 字串

請求範本

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

實時 URL https://bc-platform-auth.withhive.com/v2/refresh-token
沙盒 URL https://sandbox-bc-platform-auth.withhive.com/v2/refresh-token
HTTP 方法 POST
內容類型 application/json

請求標頭

欄位名稱 描述 類型 必填
授權 進行 API 呼叫所需的 refreshToken 字串

回應

欄位名稱 描述 類型
code API 呼叫結果代碼,0:成功 數字
message 結果訊息 字串
data API 回應值 json
data.accessToken 用於 API 使用的身份驗證令牌 字串
data.refreshToken 當 accessToken 過期時可用於更新的令牌 字串

請求範例

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"
  }
}