ข้ามไปที่เนื้อหา

รีเฟรชโทเค็น

การต่ออายุโทเค็น เป็น API ที่ต่ออายุโทเค็นการเข้าถึง/การรีเฟรชโดยใช้โทเค็นการรีเฟรชที่ออก (user_info.refresh_token) หลังจากทำการร้องขอ API การตรวจสอบการเข้าสู่ระบบและการดึงข้อมูลผู้ใช้

Note

โทเค็นการเข้าถึงมีอายุการใช้งาน 1 ชั่วโมงหลังจากออก และสามารถต่ออายุได้โดยใช้โทเค็นการรีเฟรชก่อนหรือหลังจากหมดอายุ อายุการใช้งานของโทเค็นการรีเฟรชคือ 30 วัน.

คำขอ URL

สภาพแวดล้อม URL
การผลิต https://weblogin.withhive.com/oauth/token
Sandbox https://sandbox-weblogin.withhive.com/oauth/token
HTTP Method POST
Content-Type application/json

ร่างคำขอ

ชื่อฟิลด์ ประเภท คำอธิบาย จำเป็น
grant_type สตริง OAuth 2.0 authorization code flow default: refresh_token ใช่
client_id สตริง OAuth 2.0 Client ID ที่สร้างขึ้นในการตั้งค่ากุญแจความปลอดภัย คุณสามารถตรวจสอบได้ใน Hive console App Center > Security Key Settings. ใช่
client_secret สตริง OAuth 2.0 Client Secret ที่สร้างขึ้นในการตั้งค่ากุญแจความปลอดภัย คุณสามารถตรวจสอบได้ใน Hive console App Center > Security Key Settings. ใช่
refresh_token สตริง Refresh token ใช่

ตัวอย่างเนื้อหาการร้องขอ

{
  "grant_type": "refresh_token",
  "client_id": "58b48cd3-df47-5b52-2627-3f9c8d01",
  "client_secret": "bec7760b237244c4c818d6174587d8e1",
  "refresh_token": "eyJraWQiOiIwYThlMThkOS1hNmZiLTM3ZDMtNjkwYy02Zjg1ZTllNCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc193aGl0ZWxpc3QiOmZhbHNlLCJwcm9qZWN0X2lkIjoiY29tLmNvbTJ1cy5oaXZlc2RrIiwiZ3JhbnRfdHlwZSI6InVzZXIiLCJ1c2VyX2lkIjoyMDAwMDAxODU1MiwidG9rZW5fdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJleHAiOjE3NDgxNTAzODMsImlhdCI6MTc0NTU1ODM4MywiYXV0aF92ZXIiOiJ2NCJ9.fvXTfRDYhlk21EY-ngAXbQMgYM9f-rFYPBa_GMV3JDz3cy9wwGfPTnF-VO0WkpxzpPdbG1ZX0HAdIkT4kF873ee2d-g6-JeuIEy0SFcTMpdYWXnlOfsuZlFIkzCm0OB_mlnNo_wxXHvjHM_dFDF-SfK2r9_ga8yLOXDfLJeA4XUYGwwsG3XT9x5Vy8RlUcF2aeuf-2bXdLSD2NGssZh18RTayV2CNtGuX0kj-nABVVTzLWUqbwKSrIVXjlS76zxl3SisUW_pz97iM98yLLRdpe_56_VDPzKEqVmn4bCyhhlAT1LEdu_uudlBY7hSUX0cJzcLAtj_4GReuLU9SnvQpw"
}

ร่างการตอบกลับ

ชื่อฟิลด์ ประเภท คำอธิบาย หมายเหตุ
รหัส จำนวนเต็ม รหัสตอบกลับการเข้าสู่ระบบเว็บ
access_token สตริง โทเค็นการเข้าถึง ระยะเวลา: 1 ชั่วโมง
refresh_token สตริง โทเค็นการรีเฟรช ระยะเวลา: 30 วัน

รหัสตอบกลับการเข้าสู่ระบบเว็บ

รหัส คำอธิบาย หมายเหตุ
100 สำเร็จ
1050 พารามิเตอร์ไม่ถูกต้อง
2011 ไม่มีข้อมูลโครงการ
2013 โครงการอยู่ในสถานะที่ถูกยกเลิก
7001 ไม่มีค่า OAuth2.0 Client ID ตรวจสอบใน Hive console App Center > Security Key Settings
7002 ข้อมูล OAuth2.0 Client ไม่ตรงกัน
7003 ไม่มีข้อมูล OAuth2.0 Client
7004 ประเภทการออกโทเค็นที่ไม่รองรับ OAuth2.0 ตรวจสอบ grant_type ใน Request Body
8001 ไม่สามารถสร้าง OAuth2.0 JWT
8002 ไม่สามารถตรวจสอบ OAuth2.0 JWT
8004 อัลกอริธึม OAuth2.0 ที่ไม่รองรับสำหรับ JWT
8005 ไม่สามารถตรวจสอบ OAuth2.0 JWT Kid
8006 ไม่สามารถตรวจสอบลายเซ็น OAuth2.0 JWT
8007 Payload ผิดปกติใน OAuth2.0 JWT
8008 ประเภทโทเค็นที่ไม่รองรับ OAuth2.0 โทเค็น refresh_token ใน Payload เท่านั้นที่สามารถต่ออายุได้
8009 ขอบเขตโทเค็นที่ไม่รองรับ OAuth2.0
8011 OAuth2.0 JWT หมดอายุ

ตัวอย่างเนื้อหาการตอบกลับ (สำเร็จ)

นี่คือตัวอย่างของข้อมูลการตอบกลับที่ส่งคืนเมื่อเงื่อนไขต่อไปนี้เป็นไปตามที่กำหนด

  • โทเค็นได้ถูกออกอย่างสำเร็จแล้ว.
{
  "code": 100,
  "access_token": "eyJraWQiOiIwYThlMThkOS1hNmZiLTM3ZDMtNjkwYy02Zjg1ZTllNCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc193aGl0ZWxpc3QiOmZhbHNlLCJwcm9qZWN0X2lkIjoiY29tLmNvbTJ1cy5oaXZlc2RrIiwiZ3JhbnRfdHlwZSI6InVzZXIiLCJ1c2VyX2lkIjoyMDAwMDAxODU1MiwidG9rZW5fdHlwZSI6ImFjY2Vzc190b2tlbiIsImV4cCI6MTc0NTU2MTk4MywiaWF0IjoxNzQ1NTU4MzgzLCJhdXRoX3ZlciI6InY0In0.e4mCIirRpAni4A1ZEF3FDOFng3Da8hq6IqZmyyRQZsc7W3LfFi_id5TIQSDbvmagmT4GcwHztovpoYZxf8blwqES1lJmEVXsBBJ3qpEOAem0K9aVwY0zmOO3A0Eeh6Y0APABewNCpHiKPCMZwxSsMaUE56FfuYgnbhpsipR638VgyPniRVU-Bzcu0Pi2zo-5yUKbg2FCXex510fvZRxqGZPg8Rfhm-jXqAYuwALLIFf2ZykOWqVRFtczfPXwB6fLQrQvQeBnOYcHHnR1q8Fi-Rk_bQPsAffIemGvaC4vUeyx6Szzt_Gok1BsuF76lYZ5ogCn4lAlZ0SJLrgMM2-DNQ",
  "refresh_token": "eyJraWQiOiIwYThlMThkOS1hNmZiLTM3ZDMtNjkwYy02Zjg1ZTllNCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc193aGl0ZWxpc3QiOmZhbHNlLCJwcm9qZWN0X2lkIjoiY29tLmNvbTJ1cy5oaXZlc2RrIiwiZ3JhbnRfdHlwZSI6InVzZXIiLCJ1c2VyX2lkIjoyMDAwMDAxODU1MiwidG9rZW5fdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJleHAiOjE3NDgxNTAzODMsImlhdCI6MTc0NTU1ODM4MywiYXV0aF92ZXIiOiJ2NCJ9.fvXTfRDYhlk21EY-ngAXbQMgYM9f-rFYPBa_GMV3JDz3cy9wwGfPTnF-VO0WkpxzpPdbG1ZX0HAdIkT4kF873ee2d-g6-JeuIEy0SFcTMpdYWXnlOfsuZlFIkzCm0OB_mlnNo_wxXHvjHM_dFDF-SfK2r9_ga8yLOXDfLJeA4XUYGwwsG3XT9x5Vy8RlUcF2aeuf-2bXdLSD2NGssZh18RTayV2CNtGuX0kj-nABVVTzLWUqbwKSrIVXjlS76zxl3SisUW_pz97iM98yLLRdpe_56_VDPzKEqVmn4bCyhhlAT1LEdu_uudlBY7hSUX0cJzcLAtj_4GReuLU9SnvQpw"
}

ตัวอย่างเนื้อหาการตอบกลับ (ความล้มเหลว)

นี่คือตัวอย่างของข้อมูลการตอบกลับที่ส่งกลับเมื่อมีเงื่อนไขดังต่อไปนี้

  • การออกโทเค็นล้มเหลว.
{
  "code": 1050
}