Authentication

Learn how to authenticate your requests to the Shortify API.

API Keys

All mobile API requests require the api-key header.

Key Types

  • Workspace API key: use for short-link endpoints such as/api/mobile/link and/api/mobile/link/create.
  • Deeplink app API key: use for deeplink endpoints such as/api/mobile/deeplink.

Where to Find Keys

  • Short-link API key: open/settings, then go to theApi Keystab. Use the workspace API key there (for mobile endpoints, use Mobile API Key).
  • Deeplink app API key: open/deep-links, select your app, then go to the App Settingstab and copy the App API Key.

Using Your API Key

Include your API key in the request header:

api-key: YOUR_API_KEY

API Key Security

  • Never expose your API key in client-side code
  • Use environment variables to store your API key
  • Rotate keys periodically
  • Use separate keys for development and production