Skip to content

API Authentication

Smailander uses API keys for authentication.

Creating API Keys

Create API keys in the dashboard:

  1. Navigate to Settings → API Keys
  2. Click "Create API Key"
  3. Enter key name and permissions
  4. Click "Create"
  5. Copy the key (you won't see it again)

Using API Keys

curl -X GET https://api.smailander.com/v1/emails \
  -H "Authorization: Bearer YOUR_API_KEY"

In Query Parameters

curl -X GET https://api.smailander.com/v1/emails?api_key=YOUR_API_KEY

API Key Permissions

Permission Description
emails:read Read emails
emails:write Create and update emails
honeypots:read Read honeypots
honeypots:write Create and update honeypots
webhooks:manage Manage webhooks
reports:read Read reports
reports:write Create and manage reports

Managing API Keys

List API Keys

curl -X GET https://api.smailander.com/v1/api-keys \
  -H "Authorization: Bearer YOUR_API_KEY"

Regenerate API Key

curl -X POST https://api.smailander.com/v1/api-keys/{id}/regenerate \
  -H "Authorization: Bearer YOUR_API_KEY"

Delete API Key

curl -X DELETE https://api.smailander.com/v1/api-keys/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

Best Practices

  1. Never expose keys in client-side code
  2. Use environment variables for storage
  3. Rotate keys regularly (every 90 days)
  4. Scope permissions to minimum required
  5. Monitor usage for suspicious activity

Support