Authentication¶

Learn how to authenticate with the Voucher API using API keys and understand security best practices.

Overview

The Voucher API uses API key-based authentication for all requests. Your API key identifies your account and determines which operations you can perform. This guide covers everything you need to know about API key management, security best practices, and proper authentication implementation for both development and production environments.

Getting Your API Key¶

Follow these steps to generate API key:

1. Create a Voucher API account at dashboard.voucher.com.
2. Navigate to the API Keys section in your dashboard:
3. Click the Generate API Key

4. Choose Environment: Select the appropriate environment for your API key:

   Environment	Description	Use Case
   Production	Live API with real data	Production applications
   Sandbox	Test environment	Development and testing

   Environment Separation

   Production and sandbox environments are completely separate. Data and vouchers created in sandbox won't appear in production.

Using API Keys¶

Follow these steps to use the API keys:

Request Headers¶

Include your API key in the Authorization header of all requests:

curl -X POST "https://api.voucher.com/v1/vouchers" \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "code": "SUMMER2024",
    "type": "percentage",
    "value": 20
  }'

const response = await fetch('https://api.voucher.com/v1/vouchers', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_live_...',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    code: 'SUMMER2024',
    type: 'percentage',
    value: 20
  })
});

import requests

response = requests.post(
    'https://api.voucher.com/v1/vouchers',
    headers={
        'Authorization': 'Bearer sk_live_...',
        'Content-Type': 'application/json'
    },
    json={
        'code': 'SUMMER2024',
        'type': 'percentage',
        'value': 20
    }
)

API Key Format¶

API keys follow this format:

sk_live_1234567890abcdef  # Production key
sk_test_1234567890abcdef  # Sandbox key

Security Best Practices¶

🔒 Keep Keys Secure¶

Environment Variables¶

Store your API keys securely using environment variables:

export VOUCHER_API_KEY="sk_live_..."

const apiKey = process.env.VOUCHER_API_KEY;

import os
api_key = os.environ.get('VOUCHER_API_KEY')

Key Rotation¶

Regularly rotate your API keys for enhanced security:

1. Generate new key in your dashboard
2. Update your application with the new key
3. Test thoroughly in sandbox environment
4. Deploy to production with new key
5. Revoke old key after successful deployment

Error Handling¶

Authentication Errors¶

Handle authentication errors gracefully:

try {
  const response = await fetch('https://api.voucher.com/v1/vouchers', {
    headers: {
      'Authorization': 'Bearer sk_live_...'
    }
  });

  if (response.status === 401) {
    throw new Error('Invalid API key');
  }

  const data = await response.json();
} catch (error) {
  console.error('Authentication failed:', error.message);
}

try:
    response = requests.post(
        'https://api.voucher.com/v1/vouchers',
        headers={'Authorization': 'Bearer sk_live_...'}
    )

    if response.status_code == 401:
        raise Exception('Invalid API key')

    data = response.json()
except Exception as e:
    print(f'Authentication failed: {e}')

Common Authentication Errors¶

Testing Authentication¶

Verify Your API Key¶

Test your API key with a simple request:

curl -X GET "https://api.voucher.com/v1/vouchers" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.voucher.com/v1/vouchers', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

if (response.ok) {
  console.log('API key is valid!');
}

response = requests.get(
    'https://api.voucher.com/v1/vouchers',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)

if response.status_code == 200:
    print('API key is valid!')

Next Steps¶

• Core Concepts - Understand fundamental API concepts
• Quick Start Guide - Create your first voucher
• API Reference - Complete endpoint documentation
• Error Handling - Handle API errors properly

Need Help?¶