API docs

Click headers to expand

Authentication is provided as a bearer token provided to authorised parties

Request methods: GET
Path: /developer
Get developer information -> /developer

Request methods: GET
Path: /author

Optional parameter: author_id -> /author?author_id=[...] - Returns specified content attatched to requested ID
Optional parameter: content_id -> /author?content_id=[...] - Returns specified content attached to requested ID
Optional parameter: search -> /author?search=[...] - Returns specified content containing search parameter
Optional parameter: page -> /author?page=[...] - Required integer which returns 10 entries per page.

Parameters can be used in tandem to narrow results: content_id & author_id -> /author?content_id=[...]&author_id=[...]
Parameters for this endpoint are NOT case sensitive

Request methods: GET
Path: /content

Optional parameter: author_id -> /content?author_id=[...] - Returns specified content attatched to requested ID
Optional parameter: content_id -> /content?content_id=[...] - Returns specified content attached to requested ID
Optional parameter: search -> /content?search=[...] - Returns specified content containing search parameter
Optional parameter: page -> /content?page=[...] - Required integer which returns 10 entries per page.

Parameters can be used in tandem to narrow results: content_id & author_id -> /content?content_id=[...]&author_id=[...]
Parameters for this endpoint are NOT case sensitive

Request methods: GET / POST / PATCH / DELETE
Path: /award

Method: GET

Get award information -> /award

Method: POST

Required parameter: "name"
Format example: {"name":"Test award"}
Provided the name is not already in use a new award will be created and provided an ID automatically

Method: PATCH

Required parameters: "name", "award_id"
award_id only accepts integers
Format example: {"award_id":5,"name":"Update test award"}
"award_id" is used to identify the award to update - "name" is used to update the existing information

Method: DELETE

Required parameter: "award_id"
award_id only accepts integers
Format example: {"award_id":5}
"award_id" is used to identify the award to delete

Request methods: POST / DELETE
Path: /management

Method: POST

Required parameters: "content_id", "award_id"
both parameters only accept integers
Format example: {"content_id":[...],"award": 3}
"content_id" specifies the content to update - "award" specifies the award to give to the content

Method: DELETE

Required parameters: "content_id", "award_id"
both parameters only accept integers
Format example: {"content_id":[...],"award": 3}
"content_id" specifies the content to update - "award" specifies the award to remove from to the content