API Keys

​

What API Keys Are Used For

• Fetching policy details via the REST API
• Creating Swig wallets programmatically
• Accessing paymaster services for transaction sponsorship

​

Prerequisites

• A Swig account at dashboard.onswig.com
• Access to an project

​

Creating an API Key

​

Step 1: Navigate to API Keys

1. Log in to the Developer Portal
2. Select your project from the sidebar
3. Click API Keys in the navigation menu

​

Step 2: Create New Key

1. Click the Create API Key button
2. Enter a name for your key (required, 1-100 characters)
   • Use descriptive names like production-backend or dev-testing
3. Optionally set an expiration date
   • Leave empty for keys that never expire
4. Click Create

​

Step 3: Copy Your Key

• Environment variables
• A secrets manager (AWS Secrets Manager, HashiCorp Vault, etc.)
• Your CI/CD platform’s secret storage

​

API Key Format

sk_<64-hexadecimal-characters>

sk_a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef12345678

​

Subscription Limits

​

Using Your API Key

​

In HTTP Requests

curl -X GET "https://dashboard.onswig.com/api/v1/policies/{policyId}" \
  -H "Authorization: Bearer sk_your_api_key"

​

With the SDK

import { SwigApiClient } from '@swig-wallet/api';

const client = new SwigApiClient({
  apiKey: process.env.SWIG_API_KEY,
  portalUrl: 'https://dashboard.onswig.com',
});

​

Best Practices

​

Security

• Never commit API keys to version control
• Use environment variables to store keys in your application
• Rotate keys periodically, especially if you suspect compromise
• Use separate keys for development and production environments

​

Naming Conventions

• The environment (dev-, staging-, prod-)
• The service or application using the key
• The purpose (backend-api, mobile-app, testing)

• prod-backend-service
• dev-local-testing
• staging-mobile-app

​

Expiration

• Temporary access (contractors, testing)
• Compliance requirements
• Regular rotation schedules

​

Managing API Keys

​

Viewing Keys

• Name
• Creation date
• Expiration date (if set)
• Usage count
• Last used timestamp

​

Deleting Keys

1. Find the key in the API Keys table
2. Click the Delete action
3. Confirm deletion

​

Next Steps

• Create a policy to define wallet permissions
• Fetch policies programmatically
• Create Swig wallets via the API