Linkly's Link Shortening API

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

Gerelateerd: Analytics API | Webhooks

Voordat u begint

Linkly genereert API-verzoeken in de interface die u kunt kopiëren en plakken in uw applicaties.

Dit werkt voor het aanmaken en bijwerken van links.

Bespaar tijd en laat ons het zware werk doen:

  1. 1Zie hieronder voor API-verzoeken voor het aanmaken van links.
  2. 2Kopieer de verzoeken in hun geheel. U kunt verifiëren dat ze voor u werken.
  3. 3Vraag ChatGPT of een equivalent om deze verzoeken aan te passen naar broncode voor uw applicatie. Er is geen noodzaak om tijd te besteden aan een complexe integratie. Onze API is volledig machine-leesbaar.

OpenAPI 3.0 Spec

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

Linkly's Link Shortening API Builder

Linkly's link shortening API bouwt automatisch API-verzoeken op basis van de inhoud van het formulier. U kunt de hier gegeven tekst in elke LLM plakken om automatisch code te genereren voor uw applicatie.

Linkly's API is gedocumenteerd volgens de OpenAPI-standaard, die verder gaat dan wat hieronder wordt verstrekt.

Autorisatie

U heeft nodig:

  • Uw API-sleutel
  • Werkruimte-ID

U kunt deze gegevens ophalen vanuit Linkly.

  1. 1Log in bij Linkly.
  2. 2Klik op Instellingen.
  3. 3Klik op API-sleutels.

Een link aanmaken of bijwerken

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

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 aan dat u JSON gebruikt met de Open API spec.

LabelSleutelTypeOpmerkingen
Account API-sleutelapi_keyStringVerplicht
Werkruimte-IDworkspace_idIntegerVerplicht
Link-IDidIntegerVerplicht bij bijwerken van bestaande link
BestemmingurlStringVerplicht
BijnaamnameString
NotitiesnoteString
Retargeting tags (head-regio)head_tagsStringVoor retargeting pixels
Retargeting tags (body-regio)body_tagsStringVoor retargeting pixels
Parameters doorsturenforward_paramsBoolean
PublicatiestatusenabledBoolean
UTM Sourceutm_sourceStringVoor UTM tracking
UTM Mediumutm_mediumStringVoor UTM tracking
UTM Campaignutm_campaignStringVoor UTM tracking
UTM Termutm_termStringVoor UTM tracking
UTM Contentutm_contentStringVoor UTM tracking
Aangepast domeindomainStringVerplicht als slug is opgegeven. Zie aangepaste domeinen
Aangepast domeinsuffixslugStringAls domein is opgegeven en slug is null, wordt automatisch gegenereerd
Open Graph-titelog_titleStringVoor social media previews
Open Graph-beschrijvingog_descriptionStringVoor social media previews
Open Graph-afbeelding URLog_imageStringVoor social media previews
Meta Pixel-IDfb_pixel_idStringVoor Meta Pixel
Google Analytics 4-IDga4_tag_idString
Google Tag Manager containergtm_idString
Vervaldatumexpiry_datetimeISO8601 DateTime StringVoor verlopende links
Vervalbestemmingexpiry_destinationStringVoor verlopende links
RegelsrulesJSON arrayVoor rotators, geo-redirects en apparaat redirects

Voorbeeldverzoek met cURL

De onderstaande code illustreert hoe u een API-verzoek kunt doen om een link aan 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 zal een JSON-object retourneren dat de link vertegenwoordigt, samen met een 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
}

Een link bijwerken

Om een link bij te werken, stuurt u hetzelfde verzoek dat u zou gebruiken om de link aan te maken, maar neemt u het veld id op voor de link die u wilt bijwerken, evenals de wijzigingen.

Rotators aanmaken via API

Om een rotator aan te maken, dient u een veld genaamd rules in als een JSON-array, samen met de bovenstaande link payload. 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 aanmaken via API

Om per land om te leiden, dient u een veld genaamd rules in als een JSON-array, samen met de bovenstaande link payload. 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 landcode.

Apparaat Redirects aanmaken via API

Om per apparaat om te leiden, dient u een veld genaamd rules in als een JSON-array, samen met de bovenstaande link payload.

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 aanmaken of bijwerken in één verzoek

Linkly ondersteunt het aanmaken/wijzigen van maximaal 1000 links per verzoek.

Om dit te doen, dient u uw API-sleutel in als onderdeel van het verzoek als volgt:

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

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

[{link}, {link}]

Hier is een compleet verzoek dat twee links zal bijwerken:

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 zowel voor aanmaak- als bijwerkacties.

Houd er rekening mee dat het tot 60 seconden kan duren voor een groot verzoek. Als verzoeken langer duren, zullen ze mislukken en moet u overwegen uw werkbelasting op te splitsen in kleinere stukken.

Snelheidslimieten

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

Gerelateerd

Track 1000 monthly clicks with all features included.

No credit card required