Authentication

Server API Authentication

The Apliko Link API uses Server API Keys for authentication. You must include a Server API key in every request to the API. Select your desired environment below.

API Environment

https://sandbox-api.apliko.link

Server API Key

Server API keys are used for server-to-server communication and authenticating requests to our backend services. This applies to the Short Links API (`/v1/shortLinks`) and the Firebase Migration API (`/v1/firebase/migrate/migrate`).

Need a Server API Key?

Server API keys are generated for each project you create. Go to your Hub to create a project.

Using Your Server API Key

To try the interactive consoles in this documentation, you'll need to set your Server API key. The key will be stored for your browser session and will not be saved on our servers.

Manage Server API Key for Docs

Use the button below to set or update your Server API key for the interactive examples.

The Server API key must be included in the X-API-KEY header of your requests. When using the live API consoles in this documentation, you will be prompted to enter your key if it has not been set for the session.

bash
X-API-KEY: YOUR_SERVER_API_KEY

Example Request (curl)

Here is an example using curl to make an authenticated request to the Firebase migration endpoint for the selected environment.

bash
curl -X POST "https://sandbox-api.apliko.link/v1/firebase/migrate/migrate" \
  -H "X-API-KEY: YOUR_SERVER_API_KEY" \
  -H "Content-Type": "application/json" \
  -d '{ "links": ["https://example.page.link/link1"] }'