getAuthCode

Untitled diagram-2024-08-05-100939.png

Obtain System AuthCode to get System rights token,This method can use the following parameters.

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	unique_id for user account	string	Y		Please fill in a unique identifiable value.
name	name	string	N		If a display name is not provided, a random string will be used.
example:USER-12345678
role	Role of the Logged-in User	string	Y		This endpoint allows users to log in as a participant.There two roles to choose, MODERATOR or PUBLISHER

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

Parameter	Meaning	Type	Existed	Default value	Description
`BODY`
status	response status	string	Y		0: fail
1: success
2: warning
message	message	string	Y	“”	Error messages should be shown when there are errors.
info	Return Information	object
code	User Authentication Code	string			use this code to get token

The following is a table of error messages returned by the API.

Code	Status	Message
`200`	1	success
	0	Unauthorized Access
`404`		Resource Not Found
`403`		Access to the requested resource is not allowed