API Documentation
In this page, we are going to learn how to use and access the CodeBoard features and implement it to your application
If you have questions, feel free to contact us.
Endpoints
We currently support four endpoints for public use. These include
Getting Started
You can only access selected endpoints without an API Key. This is to prevent any anonymous DDoS attacks.
NOTE: API Keys should be stored privately. This should not be shared with anyone just like an account token. We will not be responsible for account deactivation.
You can only access
You should note that without an API Key, /fetch endpoint returns encrypted files instead of an usable decrypted counterpart. So we highly recommend getting an API Key.
With API Key, you can access all the endpoints provided including /fetch endpoint which returns decrypted files when providing API Key.
You can pass your API Key as Authorization
headers or by url parameter key
.
All our endpoints return a JSON
with application/json as Content-Type headers except the teapot and ping endpoints.
https://codeboard.tech/api
Get your API Key in Accounts page if youve signed in before.
npm Package
@codeboard/api