콘텐츠로 이동

Blockchain Auth API

Auth API는 Hive Blockchain API, Blockchain Open API 사용 시 인증에 필요한 토큰을 발급하는 API입니다.

인증 토큰 발급¶

블록체인 서비스 API 사용에 필요한 인증 토큰을 발행하는 API입니다.

Request URL¶

Live URL	https://bc-platform-auth.withhive.com/v2/auth-token
Sandbox URL	https://sandbox-bc-platform-auth.withhive.com/v2/auth-token
HTTP Method	POST
Content-Type	application/json

Request body¶

필드명	설명	타입	필수 여부
id	인증 토큰을 발급받기 위한 ID	string	Y
secretKey	API 사용에 필요한 비밀 key	string	Y

Responses¶

필드명	설명	타입
code	api 호출 결과 코드 , 0:성공	number
message	결과 메시지	string
data	API 응답 값	json
data.accessToken	API 사용에 필요한 인증토큰	string
data.refreshToken	accessToken 만료 시 갱신할 수 있는 토큰	string

Request sample¶

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

Response sample¶

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

인증 토큰 재발급¶

인증 토큰이 만료된 경우 인증 토큰 발급 시 함께 받은 Refresh Token을 이용하여 블록체인 서비스 API(Hive 블록체인 Open API, Hie 블록체인 API) 사용에 필요한 인증 토큰을 발행하는 API입니다.

Request URL¶

Live URL	https://bc-platform-auth.withhive.com/v2/refresh-token
Sandbox URL	https://sandbox-bc-platform-auth.withhive.com/v2/refresh-token
HTTP Method	POST
Content-Type	application/json

Request header¶

필드명	설명	타입	필수 여부
Authorization	API 호출 시 요구되는 refreshToken	string	Y

Request body¶

Request Body는 없습니다.

Response¶

필드명	설명	타입
code	api 호출 결과 코드 , 0:성공	number
message	결과 메시지	string
data	API 응답 값	json
data.accessToken	API 사용에 필요한 인증토큰	string
data.refreshToken	accessToken 만료 시 갱신할 수 있는 토큰	string

Request sample¶

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

Response sample¶

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