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 je begint

Linkly genereert API-aanvragen in de interface voor je om te kopiëren en in je applicaties in te plakken.

Dit werkt voor het maken van links en het bijwerken van links.

Bespaar tijd en laat ons het zware werk doen:

  1. 1
    Zie hieronder voor API-aanvragen voor het maken van links.
  2. 2
    Kopieer de aanvragen volledig. Je kunt verifiëren dat ze voor je werken.
  3. 3
    Vraag ChatGPT of equivalent om deze aanvragen aan te passen in broncode voor je applicatie. Er is geen noodzaak om tijd te besteden aan een complexe integratie. Onze API is volledig machine-consumable.

OpenAPI 3.0 spec

Je kunt API-aanvragen rechtstreeks genereren vanuit de Linkly gebruikersinterface.

Linkly's Link Shortening API Builder

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

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

Bekijk OpenAPI Spec

Voer uit in Postman

Autorisatie

Je hebt het volgende nodig:

  • Je API-sleutel
  • Workspace-ID

Je kunt deze gegevens ophalen vanuit Linkly.

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

Om een link te maken, hoef je alleen maar een POST-aanvraag te sturen naar:

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

met de volgende velden in de hoofdtekst.

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

Als je het veld Regels indient, moet je application/json gebruiken.

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

LabelSleutelTypeOpmerkingen
Account API-sleutelapi_keyStringVereist
Workspace-IDworkspace_idIntegerVereist
Link-IDidIntegerVereist bij het bijwerken van bestaande link
BestemmingurlStringVereist
BijnaamnameString
OpmerkingennoteString
MetagegevensmetadataObjectJe eigen sleutel-waarde-gegevens, zoals ID's uit je systeem. Zie metadata
Retargeting-tags (kopgedeelte)head_tagsStringVoor retargeting pixels
Retargeting-tags (body gedeelte)body_tagsStringVoor retargeting pixels
Parameters doorsturenforward_paramsBoolean
Verwijzer verbergenhide_referrerBooleanVerstuurt referrer-policy: no-referrer zodat de bestemming Linkly niet in de referer header ziet
MaskeringcloakingBooleanVerbergt de doel-URL achter een frame
Bots blokkerenblock_botsBooleanBlokkeert bekende bots/crawlers
Social Crawler-tracking overslaanskip_social_crawler_trackingBooleanAls block_bots aan staat, laat sociale crawlers alsnog door, zodat OG-previews werken
Openbare Analyticspublic_analyticsBooleanSchakelt de openbare /abc123.stats pagina voor deze link in
WachtwoordpasswordStringBezoekers moeten dit wachtwoord invoeren voordat ze worden doorgestuurd
PublicatiestatusenabledBoolean
UTM-bronutm_sourceStringVoor UTM-tracking
UTM-mediumutm_mediumStringVoor UTM-tracking
UTM-campagneutm_campaignStringVoor UTM-tracking
UTM-termutm_termStringVoor UTM-tracking
UTM-inhoudutm_contentStringVoor UTM-tracking
Aangepast domeindomainStringVereist als slug is opgegeven. Zie aangepaste domeinen
Aangepast domeinsuffixslugStringAls domein is opgegeven en slug null is, wordt het 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
TikTok Pixel-IDtiktok_pixel_idString
Google Analytics 4-IDga4_tag_idString
Google Tag Manager-containergtm_idString
Woorden linkifylinkify_wordsStringDoor nieuwe regels gescheiden zinnen die automatisch moeten worden verkort op landingspagina's
VervangingenreplacementsStringTekstvervangingsregels toegepast op de bestemmingspagina
Vervaldatum en -tijdexpiry_datetimeISO8601 DateTime StringVoor vervallende links
Vervaldatum bestemmingexpiry_destinationString (URL)Voor vervallende links. Moet beginnen met http.
Vervalklikkenexpiry_clicksIntegerLink laten verlopen na zoveel klikken
WebhookswebhooksArray of stringsPer-link webhook-URL's. Zie webhooks.
Gebruiker-ID's waarschuwennotify_user_idsArray of integersWorkspace-gebruiker-ID's om op elke klik op de hoogte te stellen
QR-codestijlenqr_stylesJSON objectVoor QR-codestijl. Sleutels: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
RegelsrulesJSON arrayVoor rotators, geo-redirects, en device redirects

Voorbeeld van aanvraag met curl

De onderstaande code illustreert hoe je een API-aanvraag doet 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 geeft een JSON-object terug dat de link vertegenwoordigt, samen met een link-id.

{
    "id": 9512,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "metadata": {},
    "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
}

Om een link bij te werken, stuur je dezelfde aanvraag die je zou gebruiken om een link te maken, maar voeg je het veld id toe voor de link die je wilt bijwerken, plus de wijzigingen.

Gebruik metadata om je eigen identificaties tegen een link op te slaan, zoals een bestel-ID, een CRM-contact-ID of een campagnereferentie uit je eigen systeem. Het is een reeks sleutel-waardeparen, en het komt terug wanneer je de link ophaalt en in elke webhook payload (klik- en link-events), zodat je een klik kunt matchen met het record waartoe het behoort.

Stuur het in een JSON-request body, als een object:

curl -X POST https://app.linklyhq.com/api/v1/link
-H 'Content-Type: application/json'
-d '{"api_key": "your_secret_key", "workspace_id": 1, "url": "https://example.com", "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}}'

De link in het antwoord bevat "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}.

Hoe het werkt:

  • Updates worden samengevoegd. Wanneer je een link bijwerkt, worden de sleutels die je verstuurt, toegevoegd aan de bestaande metagegevens van de link, en sleutels die je niet noemt, blijven ongewijzigd. Om een sleutel te verwijderen, stel je deze in op null (bijvoorbeeld {"metadata": {"order_id": null}}).
  • Waarden zijn strings. Getallen en booleaanse waarden worden opgeslagen als tekst, dus 42 komt terug als "42". Geneste objecten en arrays zijn niet toegestaan.
  • Limieten. Tot 20 sleutels per link, sleutels tot 40 karakters en waarden tot 500 karakters, genoeg voor een UUID.
  • Privé voor jou. Metagegevens worden nooit getoond aan personen die op de link klikken, worden niet gebruikt om de omleiding op te bouwen, en worden niet aan de doel-URL toegevoegd.
  • In de app. Je kunt metagegevens ook bekijken en bewerken in de Automation instellingen van een link, onder Metadata.

Metagegevens, opmerkingen en UTM-parameters

Metagegevens, het veld note en UTM-parameters beschrijven allemaal een link, maar doen verschillende dingen:

  • Metagegevens zijn gestructureerde sleutel-waardegegevens voor je eigen systemen. Ze worden geretourneerd door de API en verzonden in webhooks, zodat software ze kan lezen.
  • Opmerkingen zijn een enkel vrij-tekstpunt voor een persoon om in de app te lezen.
  • UTM-parameters worden aan de doel-URL toegevoegd, zodat de pagina waarnaar je bezoekers verstuurt, en de analytics daarvan, ze kunnen zien. Metagegevens nooit. Om een waarde naar de bestemmingspagina door te geven, gebruik je een UTM-parameter, of schakel je Parameters doorsturen in zodat queryparameters op de korte link worden doorgegeven.

Metagegevens en analytics

Metagegevens zijn niet opgenomen in klik-analytics of klik-exports, en je kunt niet groeperen of filteren op klikken, of zoeken naar links, op metagegevens. Om klikken aan je eigen records te koppelen, gebruik je de link id. Deze verschijnt in webhook payloads, in analytics uitgesplitst per link, en in link-antwoorden. Zoek je record op van de link id aan jouw kant, of haal de link op om zijn metagegevens te lezen.

Rotators maken via API

Om een rotator te maken, dien je een veld genaamd rules in als een JSON-array, samen met de link payload hierboven. Je 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 om te leiden op basis van land, dien je een veld genaamd rules in als een JSON-array, samen met de link payload hierboven. Je 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.

Device-redirects maken via API

Om om te leiden op basis van apparaat, dien je een veld genaamd rules in als een JSON-array, samen met de link payload hierboven.

Bijvoorbeeld:

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

Waar het veld matches een van de volgende is:

  • ios
  • android
  • windows
  • linux
  • mac

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

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

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

Gebruik vervolgens hetzelfde schema als hierboven voor de afzonderlijke linkgevallen, maar verpak de linkaanvragen in een array, van het formulier:

[{link}, {link}]

Hier is een volledige aanvraag die 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/links?api_key=API_KEY'

Dit werkt voor zowel maken als bijwerken acties.

Houd er rekening mee dat het tot 60 seconden kan duren voordat een groot verzoek wordt verwerkt. Als aanvragen langer duren, zullen ze mislukken en moet je je workload in kleinere stukken verdelen.

Tarieflimieten

De link shortening API is beperkt tot 20 aanvragen/seconde. Tot 200 aanvragen per seconde zijn beschikbaar op aanvraag. Je kunt tot 1000 links in een enkele aanvraag uploaden.

Gerelateerd

Beschikbaarheid per plan

Inbegrepen in elk plan

Plannen vergelijken →

Track 500 maandelijkse klikken gratis.