Skip to main content
API Keys are the fastest way to authenticate requests to the EffiLink API. Each key is scoped to your team account, making them ideal for backend services, scripts, and any integration where your application operates under your own EffiLink credentials.
Each EffiLink team can hold up to 3 API Keys by default. If you need additional keys, contact EffiLink support.

​
Generate an API Key

1

Open Settings

Log in to your EffiLink account, then click Settings in the top-right corner of the dashboard.
2

Navigate to API Configuration

In the Settings menu, click API Configuration, then select API Keys from the sub-menu.
3

Create a new key

Click the Create API Key button. EffiLink will generate a new key and display it on screen.
4

Save your key immediately

Copy the full key and store it securely. The second half of the key is only shown once — it cannot be retrieved again after you leave this page. If you lose it, you will need to delete the key and create a new one.

​
Authenticate a request

Add the ApiKey header to every API request, replacing YOUR_KEY with the key you generated:
Every request to a protected EffiLink endpoint must include this header. Requests without a valid ApiKey header will receive a 401 Unauthorized response.

​
Security best practices

Never expose your API Key in client-side code, public repositories, or logs. Treat it like a password:
  • Store it in an environment variable or a secrets manager (e.g., AWS Secrets Manager, HashiCorp Vault).
  • Rotate keys periodically and immediately if you suspect a key has been compromised.
  • Delete unused keys from Settings → API Configuration → API Keys to minimize your attack surface.