Short Links API
This API is designed to be a drop-in replacement for the Firebase Dynamic Links API to make migration easier. It uses a similar structure and naming convention. These endpoints use Server API Key authentication. See the Authentication section for more details.
API Environment
https://sandbox-api.apliko.linkThe Short Link Object
The Short Link object has a structure designed to mirror the original Firebase Dynamic Links API. It contains all the information needed to configure, track, and redirect a link.
Attributes
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
id | string | A unique identifier for the link. |
shortLink | string | The full short link URL. |
previewLink | string | A URL that can be used to preview the link's behavior. |
dynamicLinkInfo | object | An object containing core link details. See The dynamicLinkInfo Object section below for details. |
metadata | object | A flexible key-value object to store custom data (e.g., {"campaign": "summer-sale"}). This data is passed through to your app. |
createdAt | string | The ISO 8601 timestamp when the link was created. |
updatedAt | string | The ISO 8601 timestamp for when the link was last updated. |
The dynamicLinkInfo Object
The dynamicLinkInfo object contains the core routing and social media metadata for your short link.
Attributes
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
domainUriPrefix | string | The domain prefix for your short link. |
link | string | The deep link your app will open. |
socialMetaTagInfo | object | An object for customizing social media previews. See The socialMetaTagInfo Object for details. |
The socialMetaTagInfo Object
The socialMetaTagInfo object is used to customize the appearance of your link when it's shared on social media platforms like X (Twitter), Facebook, or LinkedIn.
Attributes
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
socialTitle | string | The title used for the social media preview card. |
socialDescription | string | The description text for the social media preview card. |
socialImageLink | string | A URL for the image to be displayed in the social media preview. |
Create a Short Link
This endpoint creates a new short link with a structure that mirrors the Firebase Dynamic Links API.
Request Body
The request body includes a dynamicLinkInfo object and a suffix option, similar to Firebase.
Live API Console
Modify the request and hit send to try the API.
curl -X POST "https://sandbox-api.apliko.link/v1/shortLinks/" \
-H "X-API-KEY: YOUR_SERVER_API_KEY" \
-H "Content-Type: application/json" \
-d '
{
"dynamicLinkInfo": {
"link": "https://my-app.com/product/123",
"socialMetaTagInfo": {
"socialTitle": "Special Product Offer",
"socialDescription": "Check out this amazing product!",
"socialImageLink": "https://example.com/preview.png"
}
},
"suffix": {
"option": "SHORT"
}
}
'Returns
If successful, it returns an object containing the shortLink and a previewLink.
{
"shortLink": "https://example.nvgt.link/abcdef",
"previewLink": "https://example.nvgt.link/abcdef?d=1"
}List all Short Links
Returns a paginated list of all short links created via this API for your project.
Query Parameters
Query Parameters
| PARAMETER | TYPE | DESCRIPTION |
|---|---|---|
limit | number | A limit on the number of objects to be returned. Limit can range between 1 and 100, default is 10. |
offset | number | Number of items to skip for pagination. Default is 0. |
Returns
Returns an object containing an array of link objects and pagination details.
Live API Console
Modify the request and hit send to try the API.
curl -X GET "https://sandbox-api.apliko.link/v1/shortLinks/" \
-H "X-API-KEY: YOUR_SERVER_API_KEY"Retrieve a Short Link
Fetches the full details of a specific short link by providing its unique ID.
Path Parameters
| PARAMETER | TYPE | DESCRIPTION |
|---|---|---|
id* | string | The unique identifier of the link to retrieve. |
Live API Console
Modify the request and hit send to try the API.
curl -X GET "https://sandbox-api.apliko.link/v1/shortLinks/your-link-id" \
-H "X-API-KEY: YOUR_SERVER_API_KEY"Returns
Returns a single Short Link object if found.
Update a Short Link
Updates the specified short link by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Path Parameters
| PARAMETER | TYPE | DESCRIPTION |
|---|---|---|
id* | string | The unique identifier of the link to update. |
Request Body
Provide any of the writable link attributes in the request body to update them.
Live API Console
Modify the request and hit send to try the API.
curl -X PATCH "https://sandbox-api.apliko.link/v1/shortLinks/your-link-id" \
-H "X-API-KEY: YOUR_SERVER_API_KEY" \
-H "Content-Type: application/json" \
-d '
{
"dynamicLinkInfo": {
"socialMetaTagInfo": {
"socialTitle": "An Even Better Product Offer!"
}
}
}
'Returns
Returns the complete, updated Short Link object.
Delete a Short Link
Permanently deletes a short link. This action is irreversible.
Path Parameters
| PARAMETER | TYPE | DESCRIPTION |
|---|---|---|
id* | string | The unique identifier of the link to delete. |
Live API Console
Modify the request and hit send to try the API.
curl -X DELETE "https://sandbox-api.apliko.link/v1/shortLinks/your-link-id" \
-H "X-API-KEY: YOUR_SERVER_API_KEY"Returns
Returns a 204 No Content on successful deletion.