コンテンツにスキップ

ブロックチェーン認証API

Auth APIは、Hive Blockchain APIを使用する際に必要な認証トークンを発行するAPIです。

認証トークンの発行¶

これは、ブロックチェーンサービスAPIを使用するために必要な認証トークンを発行するAPIです。

リクエストURL¶

ライブURL	https://bc-platform-auth.withhive.com/v2/auth-token
サンドボックスURL	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が期限切れの際に更新するために使用できるトークン	文字列

リクエストサンプル¶

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

トークン再発行¶

これは、認証トークンが期限切れになったときに受け取ったリフレッシュトークンを使用して、Hive ブロックチェーン API を利用するために必要な認証トークンを発行する 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

リクエストヘッダー¶

フィールド名	説明	タイプ	必須
Authorization	API呼び出しに必要なrefreshToken	string	Y

応答¶

フィールド名	説明	タイプ
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"
  }
}