Welcome to the Blazing API website!

You're probably looking for one of these:

Authenthication

Authenthication

POST /auth/prepare (Prepare authentication flow)

Prepares a new authenthication flow.

Request body
  • purpose: What the app does. Should be short and clear.
  • permissions: A list of valid permissions of what the app needs to do. An empty array is accepted, for identification.
  • contact: How you want to get contacted as the owner of the application.
  • name: The application name, which will be shown on the consent screen.
Response Body
  • code: 8-char code consisting of uppercase letters and numbers for the user to use. See /auth/link.
  • key: Key which will allow you to retrieve the real token after the flow is finished. See /auth/redeem.
Response Codes
  • 200: Success
  • 400: Bad request; parameters missing
  • 500: Internal server error
  • 415: Unsupported Media Type; you are using the wrong content type
  • 405: Method not allowed; you are using the wrong request method
  • 429: Too Many Requests; you've reached the ratelimit for this endpoint
Required Permissions
  • None

GET /auth/link (Start authentication flow (client-side))

Redirect the user to this page, or ask them to open it. This request should NOT be done by the server.

Query parameters
  • code: (optional) The code if redirected to make the flow faster.
Response Body
  • None
Response Codes
  • 200: Success (no code param)
  • 400: Bad request; parameters missing
  • 500: Internal server error
  • 302: Success (with code param)
  • 405: Method not allowed; you are using the wrong request method
  • 429: Too Many Requests; you've reached the ratelimit for this endpoint
Required Permissions
  • None

GET /auth/test (Test Authenthication)

Verify that your JWT is still valid and can be used to authenthicate

Query parameters
  • None
Response Body
  • None
Response Codes
  • 200: Success
  • 400: Bad request; parameters missing
  • 500: Internal server error
  • 405: Method not allowed; you are using the wrong request method
  • 429: Too Many Requests; you've reached the ratelimit for this endpoint
Required Permissions
  • None

POST /auth/redeem (Redeem auth code for token)

After a successful auth flow, you can redeem the key you were given in /auth/prepare for a token.

Request body
  • key: The key to redeem
Response Body
  • body: The JSON of the JWT. Useful if you cannot parse the JWT, otherwise can be ignored.
  • token: JWT for usage with the other APIs
Response Codes
  • 200: Success
  • 400: Bad request; parameters missing
  • 500: Internal server error
  • 415: Unsupported Media Type; you are using the wrong content type
  • 405: Method not allowed; you are using the wrong request method
  • 429: Too Many Requests; you've reached the ratelimit for this endpoint
Required Permissions
  • None

You've reached the bottom. Back to top?