Auth

getAuthCode

獲取系統AuthCode以獲取系統權限令牌，此方法可以使用以下參數。

Request:

MODERATOR example

{
    "user_id": "unique_id",
    "name":"name",
    "role":"MODERATOR"
}

PUBLISHER example

{
    "user_id": "unique_id",
    "name":"name",
    "role":"PUBLISHER"
}

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Content-Type		string	Y	application/json
arc-license-key	key	string	Y
`BODY`
user_id	用戶帳號的唯一ID	string	Y		請填寫唯一可識別的值。
name	名稱	string	N		如果未提供顯示名稱，將使用隨機字符串。
範例:USER-12345678
role	登錄用戶的角色	string	Y		此端點允許用戶以參與者身份登錄。有兩個角色可供選擇，`MODERATOR` 或 `PUBLISHER` `ADMIN` `SWITCH` `CLIENT`

Response:

{
    "status": 1,
    "message": "",
    "info": {
        "code":"XXXXXXXXXXXXXXXXXXXX"
    }
}

Parameter	Meaning	Type	Existed	Default value	Description
`BODY`
status	回應狀態	string	Y		0: 失敗
1: 成功
2: 警告
message	訊息	string	Y	“”	若有錯誤時的錯誤訊息
info	返回信息	object
code	用戶驗證碼	string			使用此代碼獲取令牌

Error code:

以下是API返回的錯誤訊息表。

Code	Status	Message
`200`	1	成功
	0	未授權訪問
`404`		資源未找到
`403`		不允許訪問請求的資源

getAuthTokenUseCode

使用 getAuthCode 獲取令牌。請在十分鐘內調用 getAuthTokenUseCode，否則代碼將過期。此API在成功登錄後提供驗證令牌。

Request:

example

{
    "grant_type":"authorization_code",
    "client_id":"arctos-webapp",
        "code":"XXXXXXXXXXX",
        "redirect_uri":"https://XXXXX.XXX.XXX"
}

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Content-Type		string	Y	application/json
`BODY`
grant_type	客戶端請求的授權類型	string	Y		此參數用於指定授權類型。
client_id	客戶來源	string	Y	webapp_user	arctos-webapp:browser
arctos-switch:moderator_device
arctos-client:publisher_device
code	帳號	string	Y		請填寫唯一可識別的值。
redirect_uri		string	N		將返回的頁面

Response:

{
    "status": 1,
    "message": "",
    "info": {
        "user_id": 1010000010,
        "access_token": "eyJ0eXAiOiJKV1QiLCXXXXXXXXX"
    }
}

Parameter	Meaning	Type	Existed	Default value	Description
`BODY`
status	回應狀態	string	Y		0: 失敗
1: 成功
2: 警告
message	訊息	string	Y	“”	若有錯誤時的錯誤訊息
info	返回信息	object
user_id	ihh中的用戶ID	number	Y
access_token	用戶驗證令牌	string	Y

Error code:

以下是API返回的錯誤訊息表。

Code	Status	Message
`200`	1	成功
	0	未授權訪問
`404`		資源未找到
`403`		不允許訪問請求的資源

checkAuthToken

驗證並檢查用戶的 access_token 授權是否有效。

Request:

example

{
    
}

Parameter	Type	Required	Default value
`HEADERS`
Content-Type	string	Y	application/json
Authorization	string	Y	Bearer
`BODY`

Response:

{
    "status": 1,
    "message": "",
    "info": {
        // decode from token
        "client_id": "arctos-switch",
        "user_id": 1010000006,
            "role": "SWITCH"
    }
}

Parameter	Meaning	Type	Existed	Default value	Description
`BODY`
status	response status	string	Y		0: fail
1: success
2: warning
message	訊息	string	Y	“”	若有錯誤時的錯誤訊息
info	返回信息	object
client_id	用戶的jwt client_id	string	Y	“”
user_id	用戶的jwt user_id	string	Y	“”
role	用戶的jwt角色	string	Y	“GUSET”
license_room		number	Y
license_path		string	Y

Error code:

以下是API返回的錯誤訊息表。

Code	Status	Message
`200`	1	成功
	0	未授權訪問
`401`	1401	授權為空
	1402	授權類型不正確
	1403	未經授權
	1404	令牌已過期
	1405	令牌無效

`404`		資源未找到
`403`	3401	未找到許可文件
	3402	許可文件類型不正確
	3403	未經授權
	3404	許可已過期
	3405	許可房間超出限制