Catalog API Documentation

Browse endpoints, parameters, and live request examples.

Authentication

How to authenticate with the CatalogAPI v2 endpoints using your API key

Getting Started

Get started with the CatalogAPI in minutes:

  1. Sign up for a free account to get instant access to the sandbox environment.
  2. Create your first sandbox API key from your dashboard and start testing right away. The full key is shown once, when you create it, so save it somewhere safe.
  3. Each account can have up to 2 active API keys per environment (sandbox/production).
  4. When ready for production, upgrade your account from the dashboard.

Quick Start: Create your account now and you'll have working API credentials in under a minute!

Your API Key

Your API key is a single opaque string you copy from your dashboard. There's nothing to assemble, decode, or encode. Copy it and use it exactly as shown. Treat it like a password.

Authorization: Bearer YOUR_API_KEY

Using Your API Key

Send your API key as a Bearer credential in the Authorization header of every API request:

# Example API request with authentication
curl -H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
https://api.catalogapi.com/api/v2/sockets

Environment Endpoints

Sandbox Environment

For development and testing

https://api.catalogapi.com/sandbox/api/v2/*

Use sandbox API keys only

Production Environment

For live operations

https://api.catalogapi.com/api/v2/*

Use production API keys only

API Key Management & Security

Security Best Practices:

  • Never expose your API key in client-side code or public repositories
  • Rotate your API keys regularly (you can have 2 active API keys for zero-downtime rotation)
  • Use environment variables to store credentials, never hardcode them
  • Monitor your API usage for unusual patterns
  • Immediately rotate your API key if you suspect it's been compromised

API Key Rotation: You can have up to 2 active API keys per environment. This allows you to rotate keys without downtime:

  1. Generate a new API key while the old one is still active
  2. Update your applications to use the new API key
  3. Once all applications are updated, deactivate the old API key

Authentication Errors

401

Unauthorized

Invalid or missing API key. Check that your API key is included in the Authorization header.

403

Forbidden

Your API key is valid but doesn't have access to this resource. This often happens when using a sandbox API key on production endpoints or vice versa.

429

Too Many Requests

Rate limit exceeded. The API has per-minute rate limits. Implement exponential backoff and retry logic in your applications.

Need Help?

New to CatalogAPI? Sign up for free to get instant access to the sandbox environment with test data.

Already have an account? Log in to your dashboard to manage your API keys.

Technical support: If you're experiencing issues or need help with integration, contact support@catalogapi.com with your account ID and we'll assist you promptly.