Link Routes

These are the API routes to do with the user links on the project.

Create a new user

POST /link/new

This is the route to create a new link.

Headers

Name	Value
Content-Type	application/json
Authorization	<key>

Body

Name	Type	Description
linkId	UUIDv4	This is the database id for the link
discordUserId	bigint	This is the users discord id
authCode	number	This is the link auth code required for linking to steam account
expiryDate	Date	This is the expiry date where the auth code expires

Response

200

{
    "created": true
}

400

403

Use Link

POST /link/use/[ Auth Code ]/[ User Id ]

This is a route to link the user id to the users discord id from the auth code

Headers

Name	Value
Content-Type	application/json
Authorization	<key>

Request

Name	Type	Description
Auth Code	number	This is the auto code needed to link accounts
User Id	UUIDv4	This is the database user id

Response

200

{
    "used": true
}

400

403

Get Link Data From Discord Id

GET /link/discordId/[ Discord Id ]

This will return link data from a users discord id.

Headers

Name	Value
Content-Type	application/json
Authorization	<key>

Response

200

If could find link discord id:

{
    "linkId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO",
    "discordUserId": "bigint",
    "authCode": number,
    "expiryDate": "2024-10-26T00:00:00.000Z"
}

If could not find link discord id:

null

403

Get Link Data From Auth Code

GET /link/get/[ Auth Code ]

This will return link data from a users discord id.

Headers

Name	Value
Content-Type	application/json
Authorization	<key>

Request

Name	Value	Description
Auth Code	number	This is the code for linking accounts

Response

200

If could find link auth code:

{
    "linkId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO",
    "discordUserId": "bigint",
    "authCode": number,
    "expiryDate": "2024-10-26T00:00:00.000Z"
}

If could not find link auth code:

null

403

Get Expiry Length

GET /link/expireLength

This will return the length of the expiry time

Headers

Name	Value
Content-Type	application/json

Response

200

If could find link auth code:

{
    "expireLength": number
}

403

Is Discord Id Linked

GET /link/exist/[ Discord Id ]

This will return if the useres discord id linked or not

Headers

Name	Value
Content-Type	application/json
Authorization	<key>

Request

Name	Value	Description
Discord Id	string	This is the users discord id

Response

200

{
    "exists": boolean
}

403

Does Auth Code Exist

GET /link/authCode/exists/[ Auth Code ]

This will return if an auth code exists or not

Headers

Name	Value
Content-Type	application/json

Request

Name	Value	Description
Auth Code	number	This is the code for linking accounts

Response

200

{
    "exists": boolean
}