SDK Installation

Every official SOASAP SDK follows the same integration model. This page explains the shared steps; platform-specific install commands and APIs live in the guides below.

Before you begin

You will need:

• ✓ A SOASAP account
• ✓ A project
• ✓ An environment
• ✓ An environment API key

If you have not completed these steps, start with Quick Start.

Installation flow

SDK installation sits in the middle of onboarding: after your project and environment exist, and before your application evaluates flags locally. The API key you copy from the dashboard connects the SDK to exactly one environment.

Every official SDK includes

• ✓ Local evaluation
• ✓ Real-time SSE synchronization
• ✓ Persistent cache
• ✓ Offline operation
• ✓ Explicit defaults
• ✓ Non-blocking startup

All SDKs share the same runtime philosophy: synchronize configuration in the background, evaluate flags from a local snapshot, and never block the request path on SOASAP Cloud.

Initialization model

Every SDK registers a client at application startup with an environment API key and optional preload:

const client = createSoasapClient({
  apiKey: "...",
  preload: true
});

Exact APIs differ by platform — AddSoasap() on .NET, SoasapProvider on React — but every SDK follows the same initialization model: one client, one API key, one environment.

Installation principles

• Use environment-specific API keys — a Development key syncs Development configuration; a Production key syncs Production. Keys are generated automatically when environments are created.
• Do not expose production API keys unnecessarily — store keys in secret managers or environment variables; avoid embedding Production keys in client-side bundles when possible.
• Enable preload where supported — lets the process serve traffic while the first synchronization completes in the background.
• Reuse a single SDK instance per environment — one client per process and environment; avoid redundant SSE connections with duplicate clients.
• Pass explicit defaults during evaluation — getBool("feature", false) ensures safe behavior when a key is missing or not yet synced.

Install by platform

Open the installation guide for your runtime. Platform-specific install commands and configuration are in each linked guide.

Common installation issues

• Flag always returns the default value — verify the API key matches the intended environment and the flag key exists in that environment.
• Dashboard changes do not appear — verify network connectivity and that the SSE stream is connected; see SSE Disconnected.
• Unexpected values — verify the flag value in the selected environment; Development and Production hold independent configuration.

After installation

1. Configure your environment API key

   Store the Development or Production key from the dashboard in your application configuration or secret manager.

2. Initialize the SDK

   Register the client once at startup with the API key for the target environment.

3. Enable preload where supported

   Use preload: true or PreloadFlags() for non-blocking startup.

4. Evaluate your first flag

   Read a flag locally and confirm the value matches the dashboard.

Continue with:

• Create Your First Flag — hands-on walkthrough in the dashboard and your app.
• Architecture — local evaluation, SSE synchronization, persistent cache, and offline operation.
• Platform guides — use the Install by platform list above for runtime-specific installation and configuration.