Environments and API Key Types

UserFlux provides two distinct environments to ensure you can develop and test safely without affecting your live user data.

  • Production: Your live environment where real user data is processed.

  • Test: A sandbox environment for development, testing, and staging. Use this to try new things before publishing to production.

You can switch between these environments using the dropdown menu in the top-right corner of your dashboard.

API Key Categories

UserFlux provides three categories of APIs, each with its own set of keys for both the Test and Production environments.

  • Integration API: The primary API used for most integrations. It allows you to update user properties and create new events. Use these API keys when integrating with the SDK and collecting data.

  • Data API: Used for querying your data warehouse to read metrics or embed analytics into your own applications.

  • Product API: Used specifically for synchronising your product catalogue and schemas with UserFlux.

Each API key has specific permissions (e.g., Read-Only, Write-Only, Read and Write) to ensure secure and controlled access.

Last updated