API Guide
In this section, we will cover public API functions.
Table of contents |
---|
Entry point
<instance-url>/api/<endpoint> example: https://boogyman.dev/api/schedule
Logged in calls
For logged in calls, user must obtain its auth token from the Account API functions (login endpoint)
All logged in calls are made having the header X-Auth-Token set with the auth token obtained
API Libraries
You can use the following javascript helpers to integrate your own frontend with the BooGYMan API.
All boilerplates can be found in the base repository: https://github.com/GlitchMedia/Project-Trancend-API-Boilerplates
Privilege / module | URL | Status | Last updated | Example boilerplate |
---|---|---|---|---|
Member / base module | <instance-url>/helpers/user.api.js example: https://boogyman.dev/helpers/user.api.js | LIVE | 2024-01-26 | https://github.com/GlitchMedia/Project-Trancend-API-Boilerplates/blob/master/member.html |
User / survey module | <instance-url>/helpers/survey.api.js example: https://boogyman.dev/helpers/survey.api.js | LIVE | 2024-01-26 | https://github.com/GlitchMedia/Project-Trancend-API-Boilerplates/blob/master/survey.html |
Account module | <instance-url>/helpers/account.api.js example: https://boogyman.dev/helpers/account.api.js | LIVE | 2024-01-26 | https://github.com/GlitchMedia/Project-Trancend-API-Boilerplates/blob/master/account.html |