API
Manage your API key for programmatic access to Yaplet and integration with external services.
What is an API Key?
Your API key is a secure token that provides full access to your Yaplet organization's data and features. It's required for all API calls and should be kept secure.
Key Points
- Organization-level: One key per organization, shared across your team
- One-time display: Keys are shown only once when generated - save them immediately
- Full access: Keys provide complete access to your account data
Managing Your API Key
Generating a Key
- Go to Settings → API Settings
- Click "Generate API Key"
- Copy and save the key immediately - it cannot be retrieved again
- Keys are prefixed with
yAPI_for easy identification
Key Management
- Regenerate: Creates a new key (old one becomes invalid)
- Delete: Removes API access entirely
Regenerating or deleting your key will break existing integrations. Update all applications with the new key.
Using Your API Key
Include your API key in the Y-API-Key header for all API requests:
Y-API-Key: yAPI_your_generated_key_here
API Use Cases
Your API key enables various integrations such as:
- Affiliate tracking - Record referrals and commissions
- Newsletter management - Bulk import contacts, start automated workflows
- Custom integrations - Connect Yaplet with your existing systems
Detailed API documentation for each endpoint is available on their respective documentation pages.
Security
Security best practices:
- Store keys securely (environment variables, secret managers)
- Never commit keys to version control
- Rotate keys regularly
- Limit access to necessary team members