Linkly's Link Shortening API

Erstellen, aktualisieren und verwalten Sie Links programmatisch mit Linkly's Link Shortening API.

Verwandt: Analytics API | Webhooks

Bevor Sie beginnen

Linkly generiert API-Anfragen in der Benutzeroberfläche für Sie zum Kopieren und Einfügen in Ihre Anwendungen.

Dies funktioniert für die Erstellung von Links und die Aktualisierung von Links.

Sparen Sie Zeit und lassen Sie uns die harte Arbeit übernehmen:

  1. 1
    Sehen Sie unten Anfragen zur Link-Erstellung API.
  2. 2
    Kopieren Sie die Anfragen vollständig. Sie können überprüfen, dass sie für Sie funktionieren.
  3. 3
    Bitten Sie ChatGPT oder ein gleichwertiges Tool, diese Anfragen in Quellcode für Ihre Anwendung anzupassen. Es ist nicht erforderlich, viel Zeit für eine komplexe Integration aufzuwenden. Unsere API ist vollständig maschinenlesbar.

OpenAPI 3.0 Spezifikation

Sie können API-Anfragen direkt aus der Linkly-Benutzeroberfläche generieren.

Linkly's Link Shortening API Builder

Linkly's Link Shortening API erstellt API-Anfragen automatisch basierend auf dem Inhalt des Formulars. Sie können den hier bereitgestellten Text in jeden LLM einfügen, um automatisch Code für Ihre Anwendung zu generieren.

Linkly's API ist mit dem OpenAPI-Standard dokumentiert, der über das hinausgeht, was unten bereitgestellt wird. Die gleichen Endpoints sind auch als One-Click-Postman-Collection verfügbar.

OpenAPI-Spezifikation anzeigen

In Postman ausführen

Autorisierung

Sie benötigen:

  • Ihren API-Schlüssel
  • Workspace ID

Sie können diese Details aus Linkly abrufen.

  1. 1
    Melden Sie sich bei Linkly an.
  2. 2
    Klicken Sie auf Einstellungen.
  3. 3
    Klicken Sie auf API-Schlüssel.

Um einen Link zu erstellen, müssen Sie lediglich eine POST-Anfrage an folgende Adresse senden:

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

mit den folgenden Feldern im Body.

Der Encoding-Typ ist x-www-form-urlencoded oder application/json.

Wenn Sie das Feld Rules übermitteln, müssen Sie application/json verwenden.

Wir empfehlen die Verwendung von JSON mit der Open API spec.

LabelKeyTypeNotes
Account API Keyapi_keyStringErforderlich
Workspace IDworkspace_idIntegerErforderlich
Link IDidIntegerErforderlich, wenn vorhandener Link aktualisiert wird
DestinationurlStringErforderlich
NicknamenameString
NotesnoteString
Retargeting tags (head region)head_tagsStringFür Retargeting-Pixel
Retargeting tags (body region)body_tagsStringFür Retargeting-Pixel
Forward Paramsforward_paramsBoolean
Hide Referrerhide_referrerBooleanSendet referrer-policy: no-referrer, damit das Ziel Linkly nicht im Referrer-Header sieht
CloakingcloakingBooleanVerbirgt die Ziel-URL hinter einem Frame
Block Botsblock_botsBooleanBlockiert bekannte Bots/Crawler
Skip Social Crawler Trackingskip_social_crawler_trackingBooleanWenn block_bots aktiviert ist, lassen Sie Social Crawler durch, damit OG-Vorschauen funktionieren
Public Analyticspublic_analyticsBooleanAktiviert die öffentliche /abc123.stats-Seite für diesen Link
PasswordpasswordStringBesucher müssen dieses Passwort eingeben, bevor die Umleitung erfolgt
Publishing StatusenabledBoolean
UTM Sourceutm_sourceStringFür UTM-Tracking
UTM Mediumutm_mediumStringFür UTM-Tracking
UTM Campaignutm_campaignStringFür UTM-Tracking
UTM Termutm_termStringFür UTM-Tracking
UTM Contentutm_contentStringFür UTM-Tracking
Custom DomaindomainStringErforderlich, wenn Slug angegeben ist. Siehe benutzerdefinierte Domains
Custom Domain SuffixslugStringWenn Domain angegeben ist und Slug null ist, wird es automatisch generiert
Open Graph Titleog_titleStringFür Social-Media-Vorschauen
Open Graph Descriptionog_descriptionStringFür Social-Media-Vorschauen
Open Graph Image URLog_imageStringFür Social-Media-Vorschauen
Meta Pixel IDfb_pixel_idStringFür Meta Pixel
TikTok Pixel IDtiktok_pixel_idString
Google Analytics 4 IDga4_tag_idString
Google Tag Manager containergtm_idString
Linkify Wordslinkify_wordsStringZeilenumbruch-getrennte Phrasen, die auf Landing Pages automatisch gekürzt werden sollen
ReplacementsreplacementsStringTextersetzungsregeln, die auf die Zielseite angewendet werden
Expiry DateTimeexpiry_datetimeISO8601 DateTime StringFür ablaufende Links
Expiry Destinationexpiry_destinationString (URL)Für ablaufende Links. Muss mit http beginnen.
Expiry Clicksexpiry_clicksIntegerLink nach dieser Anzahl von Klicks ablaufen lassen
WebhookswebhooksArray of stringsPro-Link-Webhook-URLs. Siehe Webhooks.
Notify User IDsnotify_user_idsArray of integersWorkspace-Benutzer-IDs, um bei jedem Klick benachrichtigt zu werden
QR Code Stylesqr_stylesJSON objectFür QR-Code-Styling. Keys: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
RulesrulesJSON arrayFür Rotators, Geo-Redirects und Device Redirects

Beispielanfrage mit cURL

Der folgende Code zeigt, wie Sie eine API-Anfrage zum Erstellen eines Links stellen.

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'

Eine erfolgreiche Antwort gibt ein JSON-Objekt zurück, das den Link zusammen mit einer Link ID darstellt.

{
    "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
}

Um einen Link zu aktualisieren, senden Sie die gleiche Anfrage wie zum Erstellen eines Links, aber fügen Sie das Feld id für den Link hinzu, den Sie aktualisieren möchten, zusammen mit den Änderungen.

Erstellen von Rotatoren über API

Um einen Rotator zu erstellen, senden Sie ein Feld namens rules als JSON-Array zusammen mit der obigen Link-Nutzlast. Sie müssen application/json verwenden, um JSON-Arrays zu senden.

Zum Beispiel:

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

Erstellen von Geo-Redirects über API

Um nach Land umzuleiten, senden Sie ein Feld namens rules als JSON-Array zusammen mit der obigen Link-Nutzlast. Sie müssen application/json-Encoding verwenden, um JSON-Arrays zu senden.

Zum Beispiel:

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

Das Land ist der Alpha-2 ISO 3166 Ländercode.

Erstellen von Device Redirects über API

Um nach Gerät umzuleiten, senden Sie ein Feld namens rules als JSON-Array zusammen mit der obigen Link-Nutzlast.

Zum Beispiel:

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

Wobei das Feld matches eines der folgenden ist:

  • ios
  • android
  • windows
  • linux
  • mac

Linkly unterstützt die Erstellung/Änderung von bis zu 1000 Links pro Anfrage.

Senden Sie dazu Ihren API-Schlüssel wie folgt als Teil der Anfrage:

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

Verwenden Sie dann das gleiche Schema wie bei den einzelnen Link-Fällen, aber wickeln Sie die Link-Anfragen in ein Array der Form:

[{link}, {link}]

Hier ist eine vollständige Anfrage, die zwei Links aktualisiert:

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'

Dies funktioniert sowohl für Erstellungs- als auch für Aktualisierungsaktionen.

Bitte beachten Sie, dass große Anfragen bis zu 60 Sekunden dauern können. Wenn Anfragen länger dauern, schlagen sie fehl, und Sie sollten Ihre Arbeitslast in kleinere Teile aufteilen.

Rate Limits

Die Link Shortening API ist auf 20 Anfragen/Sekunde begrenzt. Auf Anfrage sind bis zu 200 Anfragen pro Sekunde verfügbar. Sie können bis zu 1000 Links in einer einzelnen Anfrage hochladen.

Verwandt

Tarifverfügbarkeit

Enthalten in jedem Tarif

Tarife vergleichen →

Verfolgen Sie 500 monatliche Klicks kostenlos.