Authentication

Part of the Getting Started flow. The Postscale API uses API keys for authentication. Include your API key in the Authorization header of every request.

Getting Your API Key

1. Log in to the Postscale Dashboard
2. Navigate to Settings → API Keys
3. Click Create API Key
4. Give your key a descriptive name (e.g., "Production Backend")
5. Copy the key immediately — it won't be shown again

Using Your API Key

Include your API key in the Authorization header with the Bearer prefix:

curl -X GET https://api.postscale.io/v1/emails \
  -H "Authorization: Bearer ps_live_abc123xyz"

API Key Types

Postscale provides two types of API keys:

Test keys allow you to develop and test your integration without sending actual emails or affecting your quotas.

SDK Authentication

Node.js

import { Postscale } from '@postscale/sdk';

const postscale = new Postscale('ps_live_your_api_key');

// All subsequent calls are authenticated
await postscale.emails.send({ ... });

Python

from postscale import Postscale

client = Postscale(api_key='ps_live_your_api_key')

# All subsequent calls are authenticated
client.emails.send(...)

Go

import "github.com/postscale/postscale-go"

client := postscale.NewClient("ps_live_your_api_key")

// All subsequent calls are authenticated
client.Emails.Send(ctx, &postscale.SendEmailParams{...})

Security Best Practices

Recommended Practices

1. Use environment variables: Store API keys in environment variables, not in code
2. Rotate keys regularly: Create new keys and deprecate old ones periodically
3. Use separate keys: Use different keys for development, staging, and production
4. Limit permissions: Create scoped keys when available (coming soon)
5. Monitor usage: Check the dashboard regularly for unexpected activity

Environment Variables Example

# .env file (never commit this!)
POSTSCALE_API_KEY=ps_live_abc123xyz

// Load from environment
const postscale = new Postscale(process.env.POSTSCALE_API_KEY);

Rate Limits

API requests are rate-limited based on your plan:

Exceeding rate limits returns a 429 Too Many Requests response. Implement exponential backoff in your integration.

Revoking Keys

To revoke an API key:

1. Go to Settings → API Keys in the dashboard
2. Find the key you want to revoke
3. Click the Revoke button
4. Confirm the action

Revoked keys immediately stop working. Update your applications before revoking active keys.