HMAC Authentication v1Secure Integration with External Systems

Request signing with HMAC-SHA256 for API integrity and authentication

Getting Started

View Examples

🔒 Secure Authentication

HMAC-SHA256 signature-based authentication ensures request integrity and authenticity.

🛡️ Replay Protection

Timestamp validation prevents replay attacks with configurable time window (default 5 minutes).

🔑 Credential Management

Support for service and user credentials with tenant isolation and role-based access.

⚡ Simple Integration

Clear specification with code examples in TypeScript, Python, and cURL for quick implementation.

Quick Example

typescript

// Generate HMAC signature
const signature = generateHMAC({
  method: 'POST',
  path: '/api/data',
  headers: {
    'x-date': '2025-10-14T03:52:12Z',
    'x-request-id': 'bf6c5652-9656-4167-b1d4-10c690a72102',
    'x-client-type': 'service'
  },
  body: '{"message": "Hello from External System"}',
  secretKey: 'your-secret-key'
});

Key Features

🎯 What This Guide Covers

Authentication Flow - Step-by-step HMAC signature generation
Implementation Examples - Ready-to-use code in multiple languages
Testing & Debugging - Validate your implementation with test cases
Error Handling - Common errors and how to resolve them