Skip to main content

API Key Management

This guide explains how to obtain API keys from the MOSA admin dashboard for SDK integration.

Overview​

API keys are required for SDK initialization and authentication. Each API key is associated with an organization.

Obtaining API Keys​

Step 1: Access Admin Dashboard​

  1. Log in to the MOSA admin dashboard (contact MOSA for access)
  2. Navigate to Settings → API Keys

Step 2: Create API Key​

  1. Click Create API Key
  2. Provide a name for the key (e.g., "Mobile App Production")
  3. Select permissions/scopes (if applicable)
  4. Click Create

Step 3: Copy API Key​

  1. Copy the generated API key immediately
  2. Important: API keys are only shown once - store securely
  3. Use the key in your SDK initialization

Using API Keys​

Initialize SDK with API Key​

val sdk = MOSADockSDK.builder()
    .setActivity(this)
    .setApiKey("your-api-key-here")  // Use your API key
    .setUserId("user-123")
    .build()

Security Best Practices​

1. Store Securely​

  • Never commit API keys to version control
  • Use environment variables or secure storage
  • Use different keys for development and production

2. Rotate Regularly​

  • Rotate API keys periodically
  • Revoke compromised keys immediately
  • Update keys in all environments

3. Limit Access​

  • Use separate keys for different environments
  • Restrict key permissions when possible
  • Monitor key usage

Environment-Specific Keys​

Development​

Use a development API key for testing:

val apiKey = if (BuildConfig.DEBUG) {
    "dev-api-key"
} else {
    "prod-api-key"
}

Production​

Use a production API key for release builds:

  • Store in secure configuration
  • Never expose in client-side code if possible
  • Consider backend proxy for additional security

Troubleshooting​

Invalid API Key Error​

If you receive an authentication error:

  1. Verify API key is correct (no extra spaces)
  2. Check API key is active in admin dashboard
  3. Ensure API key has required permissions
  4. Verify organization access

Key Not Found​

If API key is not found:

  1. Check key was copied correctly
  2. Verify key exists in admin dashboard
  3. Ensure key hasn't been revoked
  4. Contact support if issue persists

Next Steps​

For admin dashboard access, contact MOSA support.