Authentication

How to access the api

This API supports three primary authentication methods: API Key, Environment-based authentication and, optionally, Fingerprint-based session handling.

API Keys

Obtained from the dashboard, It requires a unique apiKeyUUID and apiKey. These credentials must be included in every request, and the apiKey should be stored securely, as it is shown only once.

Environments

Obtained from the dashboard, It requires a unique environmentUUID and envSecret. These credentials must be included only when creating a session (only if fingerprint was used), and the envSecret should be stored securely, as it is shown only once.

Fingerprints

An optional feature that generates a unique secret for each client user device. This allows session data to be encrypted using both the envSecret and the fingerprintSecret, enhancing security by ensuring that session data can only be decrypted with both secrets.