Set up the authentication for your API to help users manage their credentials.
Log in to see your API keys
| API Key | Label | Last Used | |
|---|---|---|---|
EQULS API - Authentication
Overview
All EQULS API endpoints require authentication using an API key. This guide explains how to obtain and use your API key.
Getting an API Key
To get your API key:
- Download the EQULS app from the App Store: https://apps.apple.com/us/app/equls/id6738887198
- Create an account or sign in if you already have one
- Go to Settings in the app
- Scroll down to Developer Options and expand it
- Your API key will be displayed in the "API Key" field
All EQULS accounts automatically have an associated API key at no additional cost.
Using Your API Key
- Include your API key as a query parameter named 'apiKey' in all API requests.
- The API key must be a valid 24-character hexadecimal string in the MongoDB ObjectID format.
Example of Using the API Key
When making a request to any EQULS API endpoint, include the API key like this:
GET /v1/getSports?apiKey=your_24_character_api_key
Important Considerations
- Security: Always store your API key securely and never expose it in client-side code.
- Format: Ensure your API key is in the correct format (24-character hexadecimal string).
Troubleshooting
If you encounter an error related to your API key, ensure it is correctly formatted and valid. An example of an invalid API key response is:
{
"error": "Invalid API key",
"details": [
{
"code": "invalid_string",
"message": "Must be a valid ObjectID string",
"path": ["apiKey"]
}
]
}