Skip to main content
Version: API v2.2.0

Authentication

All NINJIO API endpoints require authentication using an API key. This guide covers how to authenticate your requests and manage your API credentials.

API Key Authentication​

Getting Your API Key​

  1. Contact your NINJIO account manager or support team
  2. API keys are provided per customer account
  3. Keys are unique and should be kept secure

Using Your API Key​

Include your API key in the request header:

GET /api/api_gateway/customer/campaigns/training/
Host: api.ninjio.com
apiKey: YOUR_API_KEY_HERE
Content-Type: application/json

Example with cURL​

curl -X GET "https://api.ninjio.com/api/api_gateway/customer/campaigns/training/" \
  -H "apiKey: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

Example with JavaScript​

const response = await fetch('https://api.ninjio.com/api/api_gateway/customer/campaigns/training/', {
  method: 'GET',
  headers: {
    'apiKey': 'YOUR_API_KEY_HERE',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();

Example with Python​

import requests

headers = {
    'apiKey': 'YOUR_API_KEY_HERE',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://api.ninjio.com/api/api_gateway/customer/campaigns/training/',
    headers=headers
)

data = response.json()

Security Best Practices​

Protecting Your API Key​

  • Never commit API keys to version control
  • Store keys in environment variables or secure configuration
  • Use different keys for development and production environments
  • Rotate keys regularly

Environment Variables​

# .env file
NINJIO_API_KEY=your_api_key_here
NINJIO_BASE_URL=https://api.ninjio.com
import os
import requests

api_key = os.getenv('NINJIO_API_KEY')
base_url = os.getenv('NINJIO_BASE_URL')

headers = {'apiKey': api_key}

Rate Limits​

  • Standard rate limits apply to all API endpoints
  • Contact support if you need higher rate limits for your integration
  • Implement exponential backoff for retries

Error Handling​

Authentication Errors​

{
  "error": "Invalid API key",
  "status": 401
}
{
  "error": "API key required",
  "status": 401
}

Example Error Handling​

if (response.status === 401) {
  console.error('Authentication failed - check your API key');
  // Handle authentication error
} else if (response.status === 403) {
  console.error('Access forbidden - insufficient permissions');
  // Handle permission error
}

Testing Your Authentication​

Use this simple test to verify your API key works:

curl -X GET "https://api.ninjio.com/api/api_gateway/customer/campaigns/training/" \
  -H "apiKey: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

A successful response indicates your authentication is working correctly.