Protokols API Authentication#
Access to the Protokols API is controlled via API keys. This page outlines how to authenticate your requests.API Key#
You will be provided with an API key upon successful registration or by contacting our support team. This key is unique to your account and should be kept confidential. Do not share your API key in publicly accessible areas such as client-side code, GitHub repositories, etc.Authenticating Requests#
All API requests must include your API key. The key should be sent in an HTTP header.Replace YOUR_API_KEY_HERE with the actual API key provided to you.Authentication Failures#
If an API request is made without a valid API key, or if the key is incorrect or expired, the API will return an error response. Typically, this will be a 401 Unauthorized or 403 Forbidden HTTP status code.{
"error": {
"code": 401,
"message": "Unauthorized: API key is missing or invalid."
}
}
Security Best Practices#
Keep your API key secure: Treat your API key like a password.
Regenerate keys if compromised: If you suspect your API key has been compromised, contact support immediately to have it revoked and a new one issued.
Use environment variables: When developing applications, store your API key in environment variables rather than hardcoding it into your source code.
Further Assistance#
If you have any questions regarding API authentication or encounter any issues, please contact our support team.Modified at 2025-05-22 20:35:26
