vpn_key Authentication

All API requests require authentication using an API key passed in the HTTP header.

Header Format

X-API-Key: your_institution_api_key

Authentication Methods

The API supports the following header variations:

• X-API-Key (recommended)
• X-Api-Key
• HTTP_X_API_KEY (server variable)

Security Notes

• Keep your API key confidential and do not share it outside your institution
• Never expose API keys in client-side code or public repositories
• Use HTTPS for all API requests (enforced in production)
• Your API key only provides access to your institution's student data