Documentation
Authentication

Authentication

Authentication for the JSON Storage API is done via a secret key, which must be included in the request headers. This key provides secure access to the API endpoints and ensures that only authorized users can perform operations.

Header Parameter

X-secret-key: string (required) - The secret key used for authentication. This key should be included in the request headers for all API requests (Except Documents with visibility as public).

Security Considerations

  • Keep Your Secret Key Secure: Treat your secret key like a password and do not share it with anyone unauthorized. Store it securely and avoid exposing it in publicly accessible code or repositories.

  • Use HTTPS: Always make requests to the API over HTTPS to encrypt the communication between your client and the server, preventing interception of the secret key.

  • Rotate Your Keys: For added security, consider regularly rotating your secret keys. This practice helps mitigate the risk of unauthorized access if a key is compromised.