Monitored APIs

[GetPsyched]

In the spirit of developing a coding culture in our college, we plan to make a bunch of public API routes that anyone in the college can use for building their own tools. However, these APIs will only be accessible to any user logged into our website, i.e., no one outside of our college will be able to use these APIs.

Flow

• Each user on the platform gets their own token. This can be randomly generated or siphon some token that NextAuth uses.
• Using this token, a user can send API requests to our endpoints. Different types of users will have different levels of access to the APIs; the APIs will follow the same role based system that the website follows.

Steps

• A RESTful API mapping select models,
• Authentication,
• Authorisation,
• Enforcing rate limits,
• Documenting the APIs.