E
Exxari Developer Docsv1.0 Stable

Authentication

Secure all API requests using your API keys. Each key is unique to your account and should be kept confidential. You can generate multiple keys for different applications or environments.

How to Get Your API Keys

1

Sign Up on the Dashboard

Visit our merchant dashboard and create your account with your business information.

2

Navigate to API Settings

Once logged in, go to Settings → API Keys to access your key management console.

3

Generate New API Key

Click "Generate New Key" and choose the environment (Sandbox or Live). Give it a descriptive name for your records.

4

Copy and Store Securely

Copy your API key immediately and store it securely. You won't be able to see it again for security reasons.

Multiple API Keys

You can generate multiple API keys for different purposes:

Different Applications: One key for web, one for mobile, one for backend services

Multiple Businesses: If you manage multiple businesses under the same account, generate separate keys for each business for better organization and security

Environments: Keep sandbox and production keys separate to prevent accidental production charges during testing

Using Your API Key

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

Required Headers

X-API-Key:your_secret_api_key_here
Content-Type:application/json

Authentication Response

Response
{
  "status": "success",
  "message": "API Key is valid and authenticated.",
  "permissions": [
    "read_transactions",
    "create_payments",
    "refund_payments"
  ]
}

🔒 Security Best Practices

  • Never share your API keys publicly or commit them to version control
  • Always use HTTPS (SSL/TLS) for all API requests
  • Store keys in environment variables or secure vaults
  • Rotate your keys periodically for enhanced security
  • Use different keys for sandbox and production environments