Skip to main content

How to Use the API Key

To authenticate with the Lumytic API, include your unique API key in the request header under the apikey field. This key verifies your identity and authorizes access to your Lumytic instance.

Each request you send to the API must include this header to ensure proper authentication and security validation. Requests without a valid API key will be rejected with an authentication error.

Example HTTP Request​

  GET /product_development/v1/series

  Host: api.lumytic.com

  ApiKey: YOUR_API_KEY_HERE

  Content-Type: application/json

Example using cURL​

  curl -X GET "https://api.lumytic.com/product_development/v1/series " 

  -H "ApiKey: YOUR_API_KEY_HERE" \

  -H "Content-Type: application/json"

You should follow these guidelines when using your API key:

  • Replace YOUR_API_KEY with the key generated from the Developer Panel in your Lumytic customer portal.
  • Always keep your API key private and never expose it in client-side code or public repositories.
  • Use HTTPS endpoints for all API requests to ensure that your data is encrypted during transit.
  • If you suspect that your API key has been compromised, regenerate it immediately from your Lumytic account settings.
  • API keys can be managed, regenerated, or revoked at any time through the Lumytic customer portal.

To get a more professional experience when using the Lumytic API, you can follow these best practices:

  • Store your API key securely and avoid sharing it in public or unsecured environments.
  • Regularly review and rotate API keys if necessary to maintain security.
  • Always use encrypted connections (HTTPS) for all API interactions.

Error Response for Invalid Authentication​

If a request is made with a missing, expired, or invalid API key, the Lumytic API will respond with a 401 Unauthorized error. This indicates that the request could not be authenticated and access to the requested resource is denied.

The response typically includes an error message explaining the issue, helping you identify and correct the authentication problem. Always ensure that your API key is valid, active, and included in the request header to avoid this error.

Example Response

{
  "code": "900901",

  "message": "Invalid Credentials",

  "description": "Invalid Credentials. Make sure you have provided the correct security credentials"
}
ON THIS PAGE