Linkly's Link-Verkürzungs-API

Erstellen, aktualisieren und verwalten Sie Links programmatisch mit Linkly's Link-Verkürzungs-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 Link-Erstellung und Link-Aktualisierung.

Sparen Sie Zeit und lassen Sie uns die schwere Arbeit erledigen:

  1. 1
    Siehe unten für API-Anfragen zur Link-Erstellung.
  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 Äquivalent, diese Anfragen in Quellcode für Ihre Anwendung anzupassen. Es ist nicht nötig, 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-Verkürzungs-API-Builder

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

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

OpenAPI-Spezifikation anzeigen

In Postman ausführen

Autorisierung

Sie benötigen:

  • Ihren API-Schlüssel
  • Workspace-ID

Diese Details können Sie in 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 nur eine POST-Anfrage an senden:

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

mit den folgenden Feldern im Body.

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

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

Wir empfehlen Ihnen, JSON mit der Open API-Spezifikation zu verwenden.

BezeichnungSchlüsselTypNotizen
Account API-Schlüsselapi_keyStringErforderlich
Workspace-IDworkspace_idIntegerErforderlich
Link-IDidIntegerErforderlich beim Aktualisieren eines bestehenden Links
ZielurlStringErforderlich
SpitznamenameString
NotizennoteString
Retargeting-Tags (Head-Bereich)head_tagsStringFür Retargeting-Pixel
Retargeting-Tags (Body-Bereich)body_tagsStringFür Retargeting-Pixel
Parameter weiterleitenforward_paramsBoolean
Referrer ausblendenhide_referrerBooleanSendet referrer-policy: no-referrer, damit das Ziel Linkly im Referrer-Header nicht sieht
VerschleierungcloakingBooleanVerbirgt die Ziel-URL hinter einem Frame
Bots blockierenblock_botsBooleanBlockiert bekannte Bots/Crawler
Social-Crawler-Tracking überspringenskip_social_crawler_trackingBooleanWenn block_bots aktiviert ist, lassen Sie Social Crawler trotzdem durch, damit OG-Vorschauen funktionieren
Öffentliche Analytikpublic_analyticsBooleanAktiviert die öffentliche /abc123.stats-Seite für diesen Link
PasswortpasswordStringBesucher müssen dieses Passwort eingeben, bevor die Umleitung erfolgt
VeröffentlichungsstatusenabledBoolean
UTM-Quelleutm_sourceStringFür UTM-Tracking
UTM-Mediumutm_mediumStringFür UTM-Tracking
UTM-Kampagneutm_campaignStringFür UTM-Tracking
UTM-Termutm_termStringFür UTM-Tracking
UTM-Inhaltutm_contentStringFür UTM-Tracking
Benutzerdefinierte DomaindomainStringErforderlich, wenn Slug angegeben wird. Siehe benutzerdefinierte Domains
Benutzerdefinierte Domain-SuffixslugStringWenn Domain angegeben und Slug null ist, wird es automatisch generiert
Open Graph-Titelog_titleStringFür Social-Media-Vorschauen
Open Graph-Beschreibungog_descriptionStringFür Social-Media-Vorschauen
Open Graph-Bild-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
Wörter verknüpfenlinkify_wordsStringZeilenumbruch-getrennte Phrasen, die auf Landingpages automatisch gekürzt werden sollten
ErsetzungenreplacementsStringTextersetzungsregeln, die auf die Zielseite angewendet werden
Ablauf-Datum und -Uhrzeitexpiry_datetimeISO8601 DateTime StringFür ablaufende Links
Ablauf-Zielexpiry_destinationString (URL)Für ablaufende Links. Muss mit http beginnen.
Ablauf-Klicksexpiry_clicksIntegerLink nach dieser Anzahl von Klicks ablaufen lassen
WebhookswebhooksArray of stringsPro-Link-Webhook-URLs. Siehe Webhooks.
Benutzer-IDs benachrichtigennotify_user_idsArray of integersWorkspace-Benutzer-IDs, die bei jedem Klick benachrichtigt werden
QR-Code-Stileqr_stylesJSON objectFür QR-Code-Styling. Schlüssel: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
RegelnrulesJSON arrayFür Rotoren, Geo-Umleitungen und Geräte-Umleitungen

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 darstellt, zusammen mit einer 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
}

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

Erstellen von Rotoren über API

Um einen Rotor zu erstellen, übermitteln Sie ein Feld namens rules als JSON-Array, zusammen mit der obigen Link-Payload. 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-Umleitungen über API

Um nach Land umzuleiten, übermitteln Sie ein Feld namens rules als JSON-Array, zusammen mit der obigen Link-Payload. Sie müssen application/json-Codierung 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 Geräte-Umleitungen über API

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

Zum Beispiel:

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

Wobei das Feld matches eine der folgenden Optionen ist:

  • ios
  • android
  • windows
  • linux
  • mac

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

Dazu übermitteln Sie Ihren API-Schlüssel wie folgt als Teil der Anfrage:

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

Verwenden Sie dann das gleiche Schema wie oben für die einzelnen Link-Fälle, aber wickeln Sie die Link-Anfragen in ein Array der Form ein:

[{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/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 erwägen, Ihre Arbeitslast in kleinere Teile zu unterteilen.

Ratenlimits

Die Link-Verkürzungs-API ist auf 20 Anfragen/Sekunde begrenzt. Bis zu 200 Anfragen pro Sekunde sind auf Anfrage 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.