Linkly's Link Shortening API

Maak, werk bij en beheer links programmatisch met behulp van Linkly's Link Shortening API.

Gerelateerd: Analytics API | Webhooks

Voordat u begint

Linkly genereert API-verzoeken in de interface voor u om te kopiëren en in uw toepassingen in te plakken.

Dit werkt voor linkbepaling en linkupdate.

Bespaar tijd en laat ons het zware werk doen:

1. 1
   Zie hieronder voor API-verzoeken voor linkbepaling.
2. 2
   Kopieer de verzoeken volledig. U kunt verifiëren dat ze voor u werken.
3. 3
   Vraag ChatGPT of gelijkwaardig om deze verzoeken aan te passen aan broncode voor uw toepassing. Er is geen behoefte om tijd aan een complexe integratie door te brengen. Onze API is volledig machine-consumable.

---

OpenAPI 3.0 spec

U kunt API-verzoeken rechtstreeks genereren vanuit de Linkly-gebruikersinterface.

Linkly's API is gedocumenteerd met behulp van de OpenAPI-standaard, die verder gaat dan wat hieronder wordt verstrekt. Dezelfde eindpunten zijn ook beschikbaar als een Postman-verzameling met één klik.

OpenAPI-spec weergeven

Uitvoeren in Postman

Autorisatie

U hebt nodig:

• Uw API-sleutel
• Workspace-id

U kunt deze details ophalen vanuit Linkly.

1. 1
   Meld u aan bij Linkly.
2. 2
   Klik op Instellingen.
3. 3
   Klik op API-sleutels.

Een link maken of bijwerken

Om een link te maken, hoeft u alleen maar een POST-verzoek naar het volgende adres te sturen:

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

met de volgende velden in de body.

Het coderingstype is x-www-form-urlencoded of application/json.

Als u het veld Rules indient, moet u application/json gebruiken.

We raden u aan JSON te gebruiken met de Open API spec.

Voorbeeld request met curl

De onderstaande code illustreert hoe u een API-verzoek indient om een link te maken.

curl -X POST https://app.linklyhq.com/api/v1/link
-H 'cache-control: no-cache'
-d 'api_key=your_secret_key&workspace_id=1&url=http%3A%2F%2Fwww.wikijob.co.uk&name=Test%20Link'

Een succesvol antwoord retourneert een JSON-object dat de link vertegenwoordigt, samen met een link id.

{
    "id": 9512,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "head_tags": null,
    "body_tags": null,
    "linkify_words": null,
    "replacements": null,
    "enabled": true,
    "cloaking": false,
    "forward_params": false,
    "hide_referrer": false,
    "block_bots": false,
    "skip_social_crawler_tracking": false,
    "public_analytics": false,
    "password": 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,
    "fb_pixel_id": null,
    "tiktok_pixel_id": null,
    "ga4_tag_id": null,
    "gtm_id": null,
    "full_url": "https://l.linklyhq.com/l/2TQ",
    "rules": [],
    "expiry_datetime": null,
    "expiry_destination": null,
    "expiry_clicks": null,
    "qr_styles": null,
    "webhooks": [],
    "notify_user_ids": [],
    "workspace_id": 1448,
    "deleted": false
}

Een link bijwerken

Om een link bij te werken, stuurt u hetzelfde verzoek als voor het maken van een link, maar voegt u het veld id toe voor de link die u wilt bijwerken, samen met de wijzigingen.

Rotators maken via API

Om een rotator te maken, dient u een veld in met de naam rules als een JSON-array, samen met de linkpayload hierboven. U moet application/json gebruiken om JSON-arrays te verzenden.

Bijvoorbeeld:

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

Geo-redirects maken via API

Om omleiding per land uit te voeren, dient u een veld in met de naam rules als een JSON-array, samen met de linkpayload hierboven. U moet application/json-codering gebruiken om JSON-arrays te verzenden.

Bijvoorbeeld:

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

Het land is de alpha-2 ISO 3166 country code.

Device redirects maken via API

Om omleiding per apparaat uit te voeren, dient u een veld in met de naam rules als een JSON-array, samen met de linkpayload hierboven.

Bijvoorbeeld:

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

Waarbij het veld matches een van de volgende is:

• ios
• android
• windows
• linux
• mac

Meerdere links in één verzoek maken of bijwerken

Linkly ondersteunt het maken/wijzigen van tot 1000 links per verzoek.

Dien uw API-sleutel als volgt in als onderdeel van het verzoek:

https://app.linklyhq.com/api/v1/link?api_key=XXXXXXXXXXX

Gebruik vervolgens hetzelfde schema als hierboven voor de afzonderlijke linkgevallen, maar verpak de linkverzoeken in een array van de vorm:

[{link}, {link}]

Hier is een compleet verzoek dat twee links bijwerkt:

wget --no-check-certificate \
  --method POST \
  --timeout=0 \
  --header 'Content-Type: application/json' \
  --body-data '[
    {
        "workspace_id": "WORKSPACE_ID",
        "url": "https://nature.com",
        "name": "Test",
        "id": LINK_ID
    },
    {
        "workspace_id": "WORKSPACE_ID",
        "url": "https://science.com",
        "id": LINK_ID
    }
]' \
   'https://app.linklyhq.com/api/v1/workspace/WORKSPACE_ID/links?api_key=API_KEY'

Dit werkt voor zowel maken als bijwerkacties.

Houd er rekening mee dat het tot 60 seconden kan duren voordat een groot verzoek wordt verwerkt. Als verzoeken langer duren, mislukken ze en dient u uw werkbelasting in kleinere chunks op te splitsen.

Rate limits

De link shortening API is beperkt tot 20 verzoeken/seconde. Tot 200 verzoeken per seconde zijn op aanvraag beschikbaar. U kunt tot 1000 links in één verzoek uploaden.

Gerelateerd

• Analytics API - Exporteer clickgegevens en verkeersrapporten
• Webhooks - Real-time click notificaties
• Zapier Integration - No-code integraties