Getting Started

Configuration

Configure your Ondara project.

API Key

Keep your API key secure. Never commit it to version control or expose it in client-side code without proper restrictions configured in the dashboard.

Get your API key from the project settings in the dashboard:

1.Go to Dashboard
2.Select your project
3.Navigate to Settings → API Keys
4.Copy your API key (or create a new one)

Go to API Keys

Basic Configuration

1
2
3
4
5
6
7
8
9
10
// Unity C#
await Ondara.Initialize("YOUR_API_KEY");

// With options
await Ondara.Initialize(new OndaraConfig
{
    ApiKey = "YOUR_API_KEY",
    Environment = Environment.Development,
    LogLevel = LogLevel.Debug
});

Configuration Options

apiKeystringRequired

Your project's API key from the dashboard

environment'production' | 'development'

Environment mode. Development enables extra logging.

Default:'production'

autoRetryboolean

Automatically retry failed requests with exponential backoff.

Default:true

maxRetriesnumber

Maximum number of retry attempts.

Default:3

timeoutnumber

Request timeout in milliseconds.

Default:30000

offlineModeboolean

Enable offline support with local caching.

Default:true

cacheExpirynumber

Cache expiry time in seconds.

Default:3600

logLevel'none' | 'error' | 'warn' | 'info' | 'debug'

Logging verbosity level.

Default:'warn'

Full Configuration Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Unity C# - Full configuration
var config = new OndaraConfig
{
    ApiKey = "YOUR_API_KEY",
    Environment = Environment.Development,
    AutoRetry = true,
    MaxRetries = 5,
    Timeout = 60000,
    OfflineMode = true,
    CacheExpiry = 7200,
    LogLevel = LogLevel.Debug,
    
    // Custom error handler
    OnError = (error) => Debug.LogError($"Ondara Error: {error.Message}"),
    
    // Analytics opt-out
    EnableAnalytics = true,
};

await Ondara.Initialize(config);

Environment-Specific Configuration

Use different configurations for development and production:

1
2
3
4
5
6
7
8
9
10
11
12
13
#if UNITY_EDITOR || DEVELOPMENT_BUILD
    var apiKey = "dev_api_key_xxx";
    var environment = Environment.Development;
#else
    var apiKey = "prod_api_key_xxx";
    var environment = Environment.Production;
#endif

await Ondara.Initialize(new OndaraConfig
{
    ApiKey = apiKey,
    Environment = environment
});

Installation Unity SDK

API Key

Keep your API key secure. Never commit it to version control or expose it in client-side code without proper restrictions configured in the dashboard.

Get your API key from the project settings in the dashboard:

1.Go to Dashboard
2.Select your project
3.Navigate to Settings → API Keys
4.Copy your API key (or create a new one)

Go to API Keys

1 2 3 4 5 6 7 8 9 10 // Unity C# await Ondara.Initialize("YOUR_API_KEY"); // With options await Ondara.Initialize(new OndaraConfig { ApiKey = "YOUR_API_KEY", Environment = Environment.Development, LogLevel = LogLevel.Debug });

Configuration Options

apiKeystringRequired

Your project's API key from the dashboard

environment'production' | 'development'

Environment mode. Development enables extra logging.

Default:'production'

autoRetryboolean

Automatically retry failed requests with exponential backoff.

Default:true

maxRetriesnumber

Maximum number of retry attempts.

Default:3

timeoutnumber

Request timeout in milliseconds.

Default:30000

offlineModeboolean

Enable offline support with local caching.

Default:true

cacheExpirynumber

Cache expiry time in seconds.

Default:3600

logLevel'none' | 'error' | 'warn' | 'info' | 'debug'

Logging verbosity level.

Default:'warn'

Full Configuration Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Unity C# - Full configuration
var config = new OndaraConfig
{
    ApiKey = "YOUR_API_KEY",
    Environment = Environment.Development,
    AutoRetry = true,
    MaxRetries = 5,
    Timeout = 60000,
    OfflineMode = true,
    CacheExpiry = 7200,
    LogLevel = LogLevel.Debug,
    
    // Custom error handler
    OnError = (error) => Debug.LogError($"Ondara Error: {error.Message}"),
    
    // Analytics opt-out
    EnableAnalytics = true,
};

await Ondara.Initialize(config);

Environment-Specific Configuration

Use different configurations for development and production:

1
2
3
4
5
6
7
8
9
10
11
12
13
#if UNITY_EDITOR || DEVELOPMENT_BUILD
    var apiKey = "dev_api_key_xxx";
    var environment = Environment.Development;
#else
    var apiKey = "prod_api_key_xxx";
    var environment = Environment.Production;
#endif

await Ondara.Initialize(new OndaraConfig
{
    ApiKey = apiKey,
    Environment = environment
});