README.md

ILLA Supervisor Backend DataControl APIs

Desc

This interface is used to get the internal data of the supervisor. Note that all requests need to have a RequestToken field in the request header, generated from the other fields in the request + the internal rotor_token MD5.

Index

• Desc
• Index
• Consts
• Get Tatget User Info
  • Desc
  • API Endpoint
  • Request Header
  • Request Body
  • Response
• Get Tatget Users Info Multiple
  • Desc
  • API Endpoint
  • Request Header
  • Request Body
  • Response

Consts

Get Tatget User Info

Desc

Getting information about the target user.

API Endpoint

GET  /api/v1/dataControl/users/:targetUserID

Request Header

RequestToken: bash64(md5(sort($targetUserID)))

Request Body

// hone

Response

{
    "userID": "ILAdx4p1C7f2",
    "userUID": "70776ddc-3300-41ca-81c9-9fb0e19963a3",
    "nickname": "your_nickname",
    "avatar": "https://cdn.illasoft.com/userID/avatar.png",
    "email": "youremail@domain.com",
    "language": "en-US"
}

Get Tatget Users Info Multiple

Desc

Getting information about multiple target users.

API Endpoint

GET  /api/v1/dataControl/users/multi/:targetUserIDs 

:targetUserIDs is format by {userID1},{userID2},...

Request Header

RequestToken: bash64(md5(sort($targetUserIDs)))

Request Body

// hone

Response

The return is an object, object's key is userID (in int type).

{
    "users": {
        "14898": {
            "id": "ILAdx4p1C7f2",
            "uid": "70776ddc-3300-41ca-81c9-9fb0e19963a3",
            "teamMemberID": "",
            "nickname": "karminski-g",
            "email": "zhangxuhong@illasoft.com",
            "avatar": "",
            "language": "en-US",
            "isSubscribed": false,
            "created_at": "2023-03-03T15:54:17.486328Z",
            "updated_at": "2023-03-03T15:54:17.486328Z"
        },
        "14899": {
            "id": "ILAdx4p1C7f1",
            "uid": "51a53bc8-264c-4fe7-97c8-66b8bd73bbd5",
            "teamMemberID": "",
            "nickname": "karminski-g",
            "email": "karminski@outlook.com",
            "avatar": "",
            "language": "en-US",
            "isSubscribed": false,
            "created_at": "2023-04-26T13:46:35.127597Z",
            "updated_at": "2023-04-26T13:46:35.127597Z"
        }
    }
}