Lucra API Keys

Learn about the three primary key types for interacting with the Lucra API environments and best practices for their secure storage.

Keys must be provided by your Lucra representative. API key generation and management is not currently supported

Key Types

BACKEND

• Used for server-side API interactions.

• Must be supplied in the X-Lucra-Api-Key header.

API Setup

WEB

• Used for Lucra Web SDK implementations.

Getting Started

MOBILE

• Used for Lucra iOS, Android, and React Native SDK implementations.

iOS

Project Setup (iOS)

Android

React Native

Key Environments

Lucra provides two environments: sandbox and production. Each key type is associated with one of these environments:

• Sandbox Keys: Designed for development, these keys allow testing with accounts, transactions, and matchups in a non-production setting.

• Production Keys: Intended exclusively for live, production use.

You are expected to securely store and use two separate keys for each platform by environment.

SANDBOX_LUCRA_API_KEY = "..."
PRODUCTION_LUCRA_API_KEY = "..."

SANDBOX_LUCRA_WEB_KEY = "..."
PRODUCTIONN_LUCRA_WEB_KEY = "..."

SANDBOX_LUCRA_MOBILE_KEY = "..."
PRODUCTIONN_LUCRA_MOBILE_KEY = "..."

Usage

Ensure that you are using the appropriate key type for your intended platform and environment.

Secure Storage

• Avoid Committing to Repositories: Never store keys in your codebase.

• Use Secure Storage Solutions: Utilize GitHub secrets or similar tools.

• Fetch from Secure Remote Layer: Implement key rotation policies and retrieve keys from secure sources as needed.

Maintain stringent controls over your API keys to prevent unauthorized access and ensure reliable application functionality.

---

Starting with:

• Web SDK > 0.20.2

• Android SDK 6.0+

• iOS SDK 5.0.0+

• React Native SDK 5.0.0+

SDK initialization now requires updated API key usage.

What’s changing

• A new apiKey is required for SDK initialization.

• Previously issued mobile API keys will not work in the latest versions specified above.

• Currently shipped integrations using earlier SDK versions will continue to work, using the prior keys stored.

• Backend API keys are unchanged.

Platform behavior Mobile (Android / iOS / React Native)

• The prior apiKey + apiUrl configuration is no longer supported.

• The new apiKey must be provided at runtime.

Web

• Initialization now requires both tenantId and apiKey.

• Using tenantId alone is no longer supported.