REST Web Services

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 and getting stats on those 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.

API Access

In order to receive access to the API, please send a request to info@urlgeni.us and let us know how you might envision using the API.

We currently do not enforce any limitations to the number of requests you can make.

Versioning

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

Authentication

Access to the API end points is handle by way of an API token. All requests which come into the API must have the appropriate header record set to send the token. Any actions initiated by the API with the account token can affect deeplinks created via the UI and visa versa.

Add a header of HTTP_AUTHORIZATION and set to the token generated by the system.

Rails users may need to use encode_credentials

ActionController::HttpAuthentication::Token.encode_credentials("token")

Base URL

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.

Create / POST

To create a deeplink, make an HTTP POST request to this end point:

https://api.urlgeni.us/v1/links

Required Parameters

Parameter Description
URL 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.

Supported Applications

  • Facebook
  • Twitter
  • LinkedIn
  • Yelp
  • Google Plus
  • Youtube
  • Pinterest
  • Instagram