Home

API Keys

An API key is a unique string that identifies and authenticates your requests to the HelioNote REST API. Every request must include a valid API key to ensure secure access to your account data.

Obtaining an API Key

To get an API key, sign in to your HelioNote developer account and navigate to the API Keys section in the dashboard. From there, you can generate a new key or manage existing ones.

Using an API Key

Include your key in the Authorization header of every request, using the following format:


 Authorization: Bearer [your_api_key]

Example:


curl -X GET "https://api.helionote.com/v1/notes" \
-H "Authorization: Bearer abc123xyz456"

Security Best Practices

  • Never share your API keys publicly or expose them in client-side code.
  • Rotate keys regularly to reduce security risks.
  • If a key is compromised, revoke it immediately and generate a new one.
  • Restrict keys to specific environments or IPs whenever possible.

Common API Key Issues

  • Invalid key: Ensure you copied the key correctly.
  • Missing key: Add the Authorization header to your request.