Shorten.REST API Documentation

Shorten.REST API Documentation

The Shorten.rest API allows you to programmatically create short URLs (an 'alias') for longer URL (a 'destination').
Subscribe 
                  {
  "createdAt": 1595845801514,
  "destinations": [
    {
      "country": "string",
      "os": "string",
      "url": "string"
    }
  ],
  "domainName": "your.domain.com",
  "metatags": [
    {
      "content": "string",
      "name": "string"
    }
  ],
  "name": "aBcDe012",
  "snippets": [
    {
      "id": "string",
      "parameters": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "updatedAt": 1595845801514
}

Response example. If you want to see more check the documentation.

The Shorten.rest API allows you to programmatically create short URLs (an 'alias') for longer URLs (a 'destination').

Each alias you create can be used to redirect the end user (person clicking on the link) to one or more destination URLs. A default destination is always set and specific destinations can be set to redirect the end user to preferred destinations based on the user's geographical location (country) and device Operating System.

In order to use the Shorten.Rest URL Shortening API you can choose to bind your own branded domain, sub-domain or to use our default domain - Short.FYI

Destination Matching

When creating or editing a short URL ('alias') you can choose to specify a destination for each country and OS ([Supported OSes list](#tag/OperatingSystems)) combination.

When a user clicks on the short link, Shorten.rest will examine the end user's country (determined by User's IP) and OS (User agent) and match the most suitable destination for each user.