API Documentation

This is information todo with the API routes, it lists all of the routes as well as detailed pages to them.

Some of the routes within the API require Authentication, this allows us to make sure that any data that is meant to be kept under security, secure. This can for instance be found on the routes to-do with permissions and groups, users, and some more through out the projects API.

Authentication Keys are randomly generated when created, the routes used for it all can be seen under the authentication routes page. These routes are all secure routes and can only be requested to be created by the System Token, as well as some other secure ones such as the ones for the Web Panel where they have another way to secure themselves without storing the token when required.

If the user wanted an authentication key, they would need to request a system administrator (by default unless default permission system is changed). These authentication keys can be given notes and the user that it is being assigned to.

If the authorization header in requests is not given a valid authentication key, and it is a secure route it will respond with:

{
	"error": {
		"code": 403,
		"message": "Please specify an authorization key"
	}
}

However, if you provide a authorization header or not when the route is not secure it will not make a difference to the response from the API.

Routes:

---

User Routes:

More Detail Page: User Routes Page

Route	Method
/user/userId/[ User Id ]	GET
/user/discordId/[ Discord Id ]	GET
/user/steamId/[ Steam Id ]	GET
/user/exists/userId/[ User Id ]	GET
/user/exists/discordId/[ Discord Id ]	GET
/user/exists/steamId/[ Steam Id ]	GET
/user/updateLastJoin/userId/[ User Id ]	POST
/user/updateLastJoin/steamId/[ Steam Id ]	POST
/user/new	POST

Link Routes:

More Detail Page: Link Routes Page

Route	Method
/link/authCode/exists/[ Auth Code ]	GET
/link/discordId/[ Discord Id ]	GET
/link/get/[ Auth Code ]	GET
/link/exist/[ Discord Id ]	GET
/link/expireLength	GET
/link/new	POST
/link/use/[ Auth Code ]/[ User Id ]	POST

Discord Reaction Routes:

More Detail Page: Reaction Routes Page

Route	Method
/reaction/get/[ Discord Message Id ]/[ Discord Channel Id ]/[ Reaction Id ]/[ Discord Guild Id ]	GET
/reaction/exist/[ Discord Button Id ]/[ Discord Channel Id ]/[ Message Id ]/[ Discord Guild Id ]	GET
/reaction/add	POST
/reaction/remove	DELETE

Discord Button Routes:

More Detail Page: Button Routes Page

Route	Method
/buttons/get/[ Discord Button Id ]/[ Discord Channel Id ]/[ Discord Message Id ]/[ Discord Guild Id ]	GET
/buttons/exist/[ Discord Button Id ]/[ Discord Channel Id ]/[ Message Id ]/[ Discord Guild Id ]	GET
/buttons/add	POST
/buttons/remove	POST

Authentication Keys:

More Detail Page: Authentication Routes Page

Route	Method
/apiKeys/new/[ User To Grant Key To ]	POST
/apiKeys/new/[ User To Grant Key To ]/[ Note ]	POST
/apiKeys/remove/[ User Granted To ]	DELETE
/apiKeys/getKeys	GET
/apiKeys/getUserKeys/[ User Granted To ]	GET

Permissions and Groups:

More Detail Page: Permissions and Groups Page

Groups:

Route	Method
/permissions/new/group	POST
/permissions/delete/group/[ Group Id ]	DELETE
/permissions/new/group/user/[ Group Id ]/[ User Id ]	POST
/permissions/delete/group/user/[ Group Id ]/[ User Id ]	DELETE
/permissions/get/group/name/[ Group Name ]	GET
/permissions/get/group/id/[ Group Id ]	GET
/permissions/get/groups/user/[ User Id ]	GET
/permissions/get/group/contains/[ Group Id ]/[ User Id ]	GET
/permissions/get/groups/exists/[ Group Name ]	GET

Permissions:

Route	Method
/permissions/new/permission/[ Group Id ]	POST
/permissions/delete/permission/[ Group Id ]	DELETE
/permissions/get/permissions/cooldown/[ Permission Id ]	GET
/permissions/get/permissions/id/[ Permission Id ]	GET