Authentication

Learn how to authenticate with the Mirra SDK using API keys

The Mirra SDK uses API keys for authentication. All API requests must include your API key in the X-API-Key header.

Getting your API Key

You can generate an API key from either the web portal or the mobile app:

Option 1: Web Portal

Visit store.getmirra.app/developer/api-keys
Sign in with your Mirra account
Click Generate API Key
Copy the key immediately

Option 2: Mobile App

Open the Mirra app on your phone
Go to Settings → Developer
Tap Generate API Key
Copy the key immediately

Your API key is only displayed once when generated. Store it securely. If you lose it, you'll need to revoke it and generate a new one.

API Key Format

Mirra API keys start with the mirra_ prefix:

mirra_a1b2c3d4e5f6789abcdef0123456789...

Using your API Key

Include your API key in the X-API-Key header for API requests:

curl https://api.fxn.world/api/sdk/v1/resources \
  -H "X-API-Key: YOUR_API_KEY"

With the SDK

The SDK handles authentication automatically when initialized with your API key:

import { MirraSDK } from '@mirra-messenger/sdk';
 
const mirra = new MirraSDK({
  apiKey: process.env.MIRRA_API_KEY
});
 
// All SDK calls are automatically authenticated
const resources = await mirra.resources.list();

In application code

Always load your API key from environment variables:

// ✅ Good: Load from environment
const apiKey = process.env.MIRRA_API_KEY;
 
// ❌ Bad: Hardcoded key
const apiKey = 'mirra_a1b2c3d4...';

Python:

import os
import requests
 
headers = {
    'X-API-Key': os.environ['MIRRA_API_KEY'],
    'Content-Type': 'application/json'
}
 
response = requests.get(
    'https://api.fxn.world/api/sdk/v1/resources',
    headers=headers
)