Authentication Flow

The authentication process requires the user to contact the admin to request access. Follow the steps below to obtain the necessary credentials and authenticate with the API:

  1. Contact the admin and request a secret key for API access.
  2. Check your email for the secret key provided by the admin.
  3. Prepare your request headers as described below.

Header Requirements

Include the following headers in your API requests:

  • MISCHOOL-CODE: Must be included in all requests to ensure proper identification.

Example Request

Below is an example of how to structure your API request:

    GET /api/resource HTTP/1.1
    Host: pleiades.mizanforschool.com
    MISCHOOL-CODE: YOUR_CODE
                        

Error Responses

If authentication fails, the API will return one of the following error responses:

  • 401 Unauthorized: Invalid or missing secret key.
  • 403 Forbidden: The MISCHOOL-CODE is missing or incorrect.