API

API Authentication

Generating an API Key

API keys authenticate your requests to the Lynkd API. Each key is scoped to your account and has full access to your links and analytics.

  1. 1Go to Settings and click on the 'API Keys' tab.
  2. 2Click 'Generate New Key'.
  3. 3Give your key a descriptive name (e.g., 'Production Server', 'CI/CD Pipeline').
  4. 4Copy the key immediately. For security, the full key is only shown once. If you lose it, you will need to generate a new one.

Note: Store your API key securely. Never expose it in client-side code, public repositories, or browser requests. Use environment variables or a secrets manager.

Using Your API Key

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

Authorization: Bearer YOUR_API_KEY

Revoking Keys

If you suspect a key has been compromised, revoke it immediately from your API Keys settings page. Click the 'Revoke' button next to the key. Revoked keys stop working within 60 seconds. Generate a new key and update your applications.