Authentication Guide

Overview

The ARi API uses subscription keys for authentication. Each request must include your subscription key in the request headers. This ensures that only authorized applications can access the API.

Ocp-Apim-Subscription-Key: your-subscription-key

Getting Your Subscription Keys

Key Rotation

We provide two keys to enable zero-downtime key rotation. Here's the recommended process for rotating your keys:

Security Best Practices

Example Implementation

Here's an example of how to securely configure API authentication in a Node.js application:

// config.js - Load from environment variables
const config = {
  apiKey: process.env.ARIARI_API_KEY,
  apiBaseUrl: 'https://api.ariari.xyz',
};

if (!config.apiKey) {
  throw new Error('ARIARI_API_KEY environment variable is required');
}

export default config;

// api-client.js - Create a reusable API client
import config from './config';

export async function apiRequest(endpoint, options = {}) {
  const response = await fetch(`${config.apiBaseUrl}${endpoint}`, {
    ...options,
    headers: {
      'Ocp-Apim-Subscription-Key': config.apiKey,
      'Content-Type': 'application/json',
      ...options.headers,
    },
  });

  if (!response.ok) {
    throw new Error(`API request failed: ${response.status}`);
  }

  return response.json();
}

Rate Limiting

The ARi API enforces rate limits to ensure fair usage and system stability. Each subscription is limited to 120 requests per minute.

Authentication Errors

If authentication fails, you'll receive one of these error responses: