Authentication

AI-Generated Content – This page was generated with AI assistance and may contain inaccuracies. While likely close to accurate, please verify critical details with the stable documentation or contact support.

Authentication Overview

Request Network API uses API key authentication to secure access to endpoints. This guide covers how to obtain, manage, and use your API keys securely.

Getting API Keys

Create Account

Generate API Key

Navigate to the API Keys section and create a new API key for your project

Configure Environment

Store your API key securely in environment variables

Test Connection

Make your first authenticated API call to verify setup

API Key Management

Production Keys

Production Environment:

Use separate keys for production
Implement key rotation policies
Monitor usage and access logs
Set up rate limiting and alerts

Development Keys

Development Environment:

Use testnet for development
Separate keys for each environment
Team access management
Testing and debugging tools

Authentication Methods

Header Authentication
Environment Variables
SDK Configuration

API Key in Header (Recommended):

curl -X POST https://api.request.network/v2/requests \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "currency": "USD",
    "expectedAmount": "100",
    "payeeIdentity": "0x...",
    "reason": "Test invoice"
  }'

Optional Headers:

x-client-id: Your client identifier for request tracking
Origin: Required for browser-based requests (CORS)

Secure Key Storage:

// .env file
REQUEST_NETWORK_GATEWAY_URL=https://sepolia.gateway.request.network/

// Application code
import { RequestNetwork } from '@requestnetwork/request-client.js';
import { EthereumPrivateKeySignatureProvider } from '@requestnetwork/epk-signature';

const signatureProvider = new EthereumPrivateKeySignatureProvider({
  method: Types.SIGNATURE_METHOD.ECDSA,
  privateKey: process.env.PRIVATE_KEY
});

const requestNetwork = new RequestNetwork({
  nodeConnectionConfig: {
    baseURL: process.env.REQUEST_NETWORK_GATEWAY_URL
  },
  signatureProvider
});

SDK Authentication:

import { RequestNetwork, Types } from '@requestnetwork/request-client.js';
import { EthereumPrivateKeySignatureProvider } from '@requestnetwork/epk-signature';

const signatureProvider = new EthereumPrivateKeySignatureProvider({
  method: Types.SIGNATURE_METHOD.ECDSA,
  privateKey: process.env.PRIVATE_KEY
});

const requestNetwork = new RequestNetwork({
  nodeConnectionConfig: {
    baseURL: 'https://sepolia.gateway.request.network/'
  },
  signatureProvider
});

Security Best Practices

API Key Security

Protect Your API Keys:

Never commit API keys to version control
Use environment variables for key storage
Implement key rotation policies
Monitor for unauthorized usage
Use different keys for different environments

Network Security

Secure Communication:

Always use HTTPS for API calls
Implement request signing for sensitive operations
Use webhook signature verification
Implement rate limiting on your endpoints

Access Control

Manage Access:

Use principle of least privilege
Implement role-based access control
Regular access audits
Immediate revocation of compromised keys

Rate Limits

Rate Limiting InformationCurrent rate limits apply to API usage. Contact support for enterprise rate limit increases.

Standard Limits

Default Rate Limits:

100 requests per minute
1,000 requests per hour
10,000 requests per day

Applies to: Most API endpoints

Webhook Limits

Webhook Rate Limits:

50 webhook deliveries per minute
Exponential backoff for retries
Maximum 5 retry attempts

Applies to: Webhook delivery endpoints

Error Codes

Common authentication error responses:

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key",
    "details": "Please provide a valid API key in the Authorization header"
  }
}

What’s Next?

🔗 Webhooks

Set up real-time event notifications

🛠️ Create Request

Make your first API call

🔑 API Portal

Manage your API keys and settings

🔑 API Setup

⚙️ API Features

📚 API Reference

Authentication Overview

Getting API Keys

API Key Management

Production Keys

Development Keys

Authentication Methods

Security Best Practices

Rate Limits

Standard Limits

Webhook Limits

Error Codes

What’s Next?

🔗 Webhooks

🛠️ Create Request

🔑 API Portal

🔑 API Setup

⚙️ API Features

📚 API Reference

​Authentication Overview

​Getting API Keys

​API Key Management

Production Keys

Development Keys

​Authentication Methods

​Security Best Practices

​Rate Limits

Standard Limits

Webhook Limits

​Error Codes

​What’s Next?

🔗 Webhooks

🛠️ Create Request

🔑 API Portal

Authentication Overview

Getting API Keys

API Key Management

Authentication Methods

Security Best Practices

Rate Limits

Error Codes

What’s Next?