Use Linkly’s API

Linkly has two API’s:

• Link creation API (as documented here).

• Reporting API

Linkly OpenAPI 3.0 Spec

Linkly’s API is now documented using the OpenAPI standard, which goes beyond what is provided below.

Authorization

• Your account email address

• Your API Key

• Workspace ID

You can get these details from inside Linkly.

1. Login to Linkly.

2. Click Settings.

3. Click API Keys.

Creating or updating a link

To create a link, all you need to do is send a POST request to:

https://app.linklyhq.com/api/v1/link

with the following fields in the body.

The encoding type is x-www-form-urlencoded or application/json.

If you are submitting the Rules field to generate rotators/device/country redirects, you must use application/json.

We recommend you use JSON with the Open API spec.

Example Request using cURL

The code below illustrates how to make an API request to create a link. Note this code has been broken onto several lines for clarity.

A successful response will return a JSON object representing the link, along with a link id.

{
    "id": 9512,
    "alias": null,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "head_tags": null,
    "body_tags": null,
    "linkify_words": null,
    "enabled": true,
    "cloaking": false,
    "replacements": null,
    "domain": null,
    "slug": null,
    "utm_source": null,
    "utm_medium": null,
    "utm_campaign": null,
    "utm_term": null,
    "utm_content": null,
    "og_title": null,
    "og_description": null,
    "og_image": null,
    "full_url": "https://l.linklyhq.com/l/2TQ",
    "block_bots": false,
    "rules": [],
    "workspace_id": 1448,
    "referer_mode": null,
    "custom_referer": null,
    "click_fraud_mode": null,
    "deleted": false
}

Bulk Link Generation

Linkly's link generation API supports arrays.

Submit an array of JSON objects as above, and Linkly will generate the links.

We recommend submitting no more than 1000 links per request, and no more than 2000 links per minute.

Updating a link

In order to update a link, send the same request you’d use to create the link, but include the field link_id for the link you want to update, as well as the changes.

Creating Rotators via API

In order to create a rotator, submit a field called rules as a JSON array, along with the link payload above. You must use application/json to send JSON arrays.

For example:

[
  {what: ‘rotator’, url: ‘https://www.microsoft.com’, percentage: ‘50’},
  {what: ‘rotator’, url: ‘https://www.apple.com’, percentage: ‘50’}
]

Creating Geo-Redirects via API

In order to redirect by country, submit a field called rules as a JSON array, along with the link payload above. You must use application/json encoding to send JSON arrays.

For example:

[
  {what: ‘country’, url: ‘https://www.microsoft.com’, matches: ‘UK’}, 
  {what: ‘country’, url: ‘https://www.apple.com’, matches: ‘US’}
]

The country is the alpha-2 ISO 3166 country code.

Creating Device Redirects via API

In order to redirect by device, submit a field called rules as a JSON array, along with the link payload above.

For example:

[
  {what: ‘platform’, url: ‘https://www.google.com’, matches: ‘windows’}, 
  {what: ‘platform’, url: ‘https://www.apple.com’, matches: ‘ios’}
]

Where the field matches is one of:

• ios

• android

• windows

• linux

• mac

Reporting API

Linkly automatically produces API requests for you inside your traffic reports.

These links include your API key, and are easily customizable and usable in your own applications.

Need more?

Need something more? Let us know. We can build out almost any integration you need.