Integrations

API Keys

Generate and manage API keys for programmatic access to Terac.

API keys let you interact with Terac programmatically through the Terac API. Use them to automate opportunity creation, manage recruitment, and retrieve submission data.

Creating an API Key

Go to Settings

Navigate to your organization's Settings page and select API Keys.

Generate a key

Click Create API Key. Give it a descriptive name so you can identify it later (e.g., "Production Integration", "Staging Tests").

Copy the key

The full key is shown only once. Copy it immediately and store it securely. You cannot retrieve the full key later.

Using API Keys

Include your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

Key Scope

API keys are scoped to your organization. A single key can access all projects and opportunities within the organization.

Rate Limits

API requests are rate-limited to 100 requests per minute per key. If you exceed this limit, requests return a 429 RATE_LIMITED error. Wait and retry with exponential backoff.

Key Management

ActionDescription
RotateGenerate a new key and revoke the old one
RevokeImmediately disable a key
RenameUpdate the key's display name

Security Best Practices

  • Never commit API keys to version control
  • Use environment variables to store keys in your applications
  • Rotate keys periodically
  • Use separate keys for production and development
  • Revoke keys immediately if they may be compromised

What's Next?