Product Documentation

Overview

Welcome to the Self Hostable Dynamic Link Service documentation. This API allows you to to create dynamic links that perfectly works for pc, android and ios devices. The workflow is similar to the firebase dynamic link.


Features

Base URL

The base URL for the API is:


API Format

    curl -X POST -H "Authorization: Bearer YOUR_API_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{"long_dynamic_link": "YOUR_LONG_DYNAMIC_LINK"}' \
        https://api.example.com/v1/resources

Response

{
    "id": 1,
    "short_link": "https://api.example.com/Xyz-abc-enb"
}

Parameters

Just provide the YOUR_LONG_DYNAMIC_LINK in the following format

BASE_URL/?link=BASE_URL/PREFIX/?{YOUR_PARAMS}

Eg:
https://app.redirectme.net/link=https://app.redirectme.net/posts/?postName=hello&postId=123123&apn=com.example.beta&ofl=https://example.com
 

Other Device, Social and Campaign related parameters are also supported.

These parameters are similar to firebase dynamic link parameters

Other Platform Parameters

ofl
'''The link to open on platforms beside Android and iOS. This is useful to specify a different behavior on desktop, like displaying a full web page of the app content/payload (as specified by param link) with another dynamic link to install the app.'''
 

Android Parameters

apn

'''The package name of the Android app to use to open the link. The app must be connected to your project from the Overview page of the Firebase console. Required for the Dynamic Link to open an Android app.'''
 

afl
'''The link to open when the app isn't installed. Specify this to do something other than install your app from the Play Store when the app isn't installed, such as open the mobile web version of the content, or display a promotional page for your app. '''
 

amv
'''The versionCode of the minimum version of your app that can open the link. If the installed app is an older version, the user is taken to the Play Store to upgrade the app.'''
 

IOS Parameters

ibi
'''The bundle ID of the iOS app to use to open the link. The app must be connected to your project from the Overview page of the Firebase console. Required for the Dynamic Link to open an iOS app.'''
 

ifl
'''The link to open when the app isn't installed. Specify this to do something other than install your app from the App Store when the app isn't installed, such as open the mobile web version of the content, or display a promotional page for your app.'''
 

ius
'''Your app's custom URL scheme, if defined to be something other than your app's bundle ID'''
 

ipfl
'''The link to open on iPads when the app isn't installed. Specify this to do something other than install your app from the App Store when the app isn't installed, such as open the web version of the content, or display a promotional page for your app.'''
 

ipbi
'''The bundle ID of the iOS app to use on iPads to open the link. The app must be connected to your project from the Overview page of the Firebase console.'''
 

isi
'''Your app's App Store ID, used to send users to the App Store when the app isnt installed'''
 

imv
'''The version number of the minimum version of your app that can open the link. This flag is passed to your app when it is opened, and your app must decide what to do with it.'''

efr
'''If set to 1, skip the app preview page when the Dynamic Link is opened, and instead redirect to the app or store. The app preview page (enabled by default) can more reliably send users to the most appropriate destination when they open Dynamic Links in apps; however, if you expect a Dynamic Link to be opened only in apps that can open Dynamic Links reliably without this page, you can disable it with this parameter. This parameter will affect the behavior of the Dynamic Link only on iOS.'''
 

Social Media Parameters

st
'''The title to use when the Dynamic Link is shared in a social post.'''
 

sd
'''The description to use when the Dynamic Link is shared in a social post.'''
 

si
'''The URL to an image related to this link. The image should be at least 300x200 px, and less than 300 KB.'''
 

Campaign Parameters

utm_source
 

utm_medium
 

utm_campaign
 

utm_term
 

utm_content
 

Roadmap

Following are the roadmaps we are working this week

- Support Authentication
- Support For IOS device with version < 9
- InApp Analytics
- Optimized IOS Preview Page

NOTE:

This Product is completely inspired by firebase dynamic link For More Deapth On parameters Please Refer This link.

Author