The URLgenius REST API allows you to query meta-data about your deeplinks. You can view this information both inside your dashboard and from within the API. Creating deeplinks is easy.
Since the API is based on REST principles, it's very easy to write and test applications. You can use your browser to access URLs, and you can use pretty much any HTTP client in any programming language to interact with the API.
Click here to get your API key. You need to have a Credit Card on file in order to start using it.
We limit the API to 2 requests per second
Breaking changes to the API will be rolled out via versions in the URL path. All prior versions will remain enabled and documented.
Current Version: v1
Access to the API end points is handle by way of an API param. All requests which come into the API must have the appropriate parameter. Any actions initiated by the API with the account token can affect deep links created via the UI and visa versa.
Include a parameter and set it to your acount api key.
https://api.urlgeni.us/api/v1/links?api_key=testkey
All URLs referenced in the documentation have the following base:
https://api.urlgeni.us/
The URLgenius REST API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.
A link resource is the core of the URLgenius API and represents a deeplink into a mobile application. Once a deeplink is created, it is added to the account of the token holder. You can retrieve statistics about that deeplink, delete the deeplink, get a list of deeplinks, and of course create them with a single parameter.
To retrieve all of the deeplinks associated with the account, make an HTTP GET request to this end point:
https://api.urlgeni.us/api/v1/links
To receive 30-day statistics and more information about a deeplink, make an HTTP GET request to this end point:
https://api.urlgeni.us/api/v1/links/:id
To remove a deeplink from your account, send an HTTP DELETE request to this end point:
https://api.urlgeni.us/api/v1/links/:id
To create a deeplink, make an HTTP POST request to this end point:
https://api.urlgeni.us/api/v1/links
Required Parameters
| Parameter | Description |
|---|---|
| url | (Required) The web URL of the resource you wish to deeplink into. Our system will take the URL and automatically create the routes to get mobile users into the applications. |
| android_fallback_url | (Optional) If you want to specify a fallback url for when the app is not installed enter it here. Include full protocol. |
| ios_fallback_url | (Optional) If you want to specify a fallback url for when the app is not installed enter it here. Include full protocol. |
| path | (Optional) If you wish to customize the path for the link created pass in the path parameter. Do not include /facebook or any other social media type path information. The only part that is customizable is after that part. So if you creating a facebook link and supply path of "city" the full path to access the link would be "facebook/city". |
URLgenius can support any mobile app for iOS and Android. URL schemes are required to successfully open the app to the right page, location or feature. To have your mobile app added to the URLgenius platform at no charge, contact us at info@urlgeni.us.
