Authentication
Learn how to authenticate your requests to the Shortify API.
API Keys
All requests to the Shortify API require authentication using an API key. Your API key carries many privileges, so be sure to keep it secure. Do not share your API key in publicly accessible areas such as GitHub, client-side code, or in your browser's developer console.
Obtaining an API Key
To obtain an API key, you need to:
- Sign up for a Shortify account
- Navigate to your account settings
- Select the "API Keys" tab
- Click "Generate New API Key"
- Copy and securely store your new API key
Important
Do not share this key publicly. This key is used to authenticate API requests.
Using Your API Key
To authenticate your API requests, include your API key in the api-key header:
api-key: YOUR_API_KEYAPI Key Security
Here are some best practices for keeping your API key secure:
- Never expose your API key in client-side code
- Use environment variables to store your API key in your applications
- Implement proper access controls for your API key
- Rotate your API keys periodically
- Use different API keys for development and production environments