Linkly's Link Shortening API

Erstellen, aktualisieren und verwalten Sie Links programmgesteuert 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 Link-Erstellung und Link-Aktualisierung.

Sparen Sie Zeit und lassen Sie uns die Arbeit machen:

  1. 1
    Siehe unten für API-Anfragen zur Link-Erstellung.
  2. 2
    Kopieren Sie die Anfragen vollständig. Sie können überprüfen, ob sie für Sie funktionieren.
  3. 3
    Fragen Sie ChatGPT oder ein Äquivalent, um diese Anfragen in Quellcode für Ihre Anwendung anzupassen. Es ist nicht erforderlich, 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 automatisch API-Anfragen basierend auf dem Inhalt des Formulars. Sie können den hier angegebenen Text in jedes LLM einfügen, um automatisch Code für Ihre Anwendung zu generieren.

Linkly's API ist unter Verwendung des OpenAPI-Standards dokumentiert, der über das hinausgeht, was unten bereitgestellt wird. Die gleichen Endpoints sind auch als One-Click-Postman-Kollektion 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 senden an:

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

mit den folgenden Feldern im Text.

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

Wenn Sie das Feld Regeln einreichen, müssen Sie application/json verwenden.

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

BezeichnungSchlüsselTypHinweise
Konto-API-Schlüsselapi_keyZeichenfolgeErforderlich
Workspace-IDworkspace_idGanzzahlErforderlich
Link-IDidGanzzahlErforderlich beim Aktualisieren eines vorhandenen Links
ZielurlZeichenfolgeErforderlich
SpitznamenameZeichenfolge
NotizennoteZeichenfolge
MetadatenmetadataObjektIhre eigenen Schlüssel-Wert-Daten, z. B. IDs aus Ihrem System. Siehe Metadaten
Retargeting-Tags (Head-Bereich)head_tagsZeichenfolgeFür Retargeting-Pixel
Retargeting-Tags (Body-Bereich)body_tagsZeichenfolgeFür Retargeting-Pixel
Parameter weiterleitenforward_paramsBoolescher Wert
Referrer ausblendenhide_referrerBoolescher WertSendet referrer-policy: no-referrer, sodass das Ziel Linkly im Referer-Header nicht sieht
VerbergungcloakingBoolescher WertVerbirgt die Ziel-URL hinter einem Frame
Bots blockierenblock_botsBoolescher WertBlockiert bekannte Bots/Crawler
Social Crawler-Tracking überspringenskip_social_crawler_trackingBoolescher WertWenn block_bots aktiviert ist, lassen Sie Social Crawler trotzdem durch, damit OG-Vorschauansichten funktionieren
Öffentliche Analytikpublic_analyticsBoolescher WertAktiviert die öffentliche Seite /abc123.stats für diesen Link
PasswortpasswordZeichenfolgeBesucher müssen dieses Passwort eingeben, bevor die Umleitung erfolgt
VeröffentlichungsstatusenabledBoolescher Wert
UTM-Quelleutm_sourceZeichenfolgeFür UTM-Tracking
UTM-Mediumutm_mediumZeichenfolgeFür UTM-Tracking
UTM-Kampagneutm_campaignZeichenfolgeFür UTM-Tracking
UTM-Begriffutm_termZeichenfolgeFür UTM-Tracking
UTM-Inhaltutm_contentZeichenfolgeFür UTM-Tracking
Benutzerdefinierte DomaindomainZeichenfolgeErforderlich, wenn slug angegeben ist. Siehe benutzerdefinierte Domains
Benutzerdefiniertes Domain-SuffixslugZeichenfolgeWenn domain bereitgestellt wird und slug null ist, wird es automatisch generiert
Open Graph-Titelog_titleZeichenfolgeFür Social-Media-Vorschauansichten
Open Graph-Beschreibungog_descriptionZeichenfolgeFür Social-Media-Vorschauansichten
Open Graph-Bild-URLog_imageZeichenfolgeFür Social-Media-Vorschauansichten
Meta Pixel IDfb_pixel_idZeichenfolgeFür Meta Pixel
TikTok Pixel IDtiktok_pixel_idZeichenfolge
Google Analytics 4 IDga4_tag_idZeichenfolge
Google Tag Manager-Containergtm_idZeichenfolge
Wörter verlinkenlinkify_wordsZeichenfolgeZeilenumbruch-getrennte Ausdrücke, die auf Landingpages automatisch gekürzt werden sollten
ErsetzungenreplacementsZeichenfolgeTextersetzungsregeln, die auf die Zielseite angewendet werden
Verfallsdatum/-Zeitexpiry_datetimeISO8601 DateTime-ZeichenfolgeFür ablaufende Links
Verfallszielexpiry_destinationZeichenfolge (URL)Für ablaufende Links. Muss mit http beginnen.
Verfallsklicksexpiry_clicksGanzzahlLink nach dieser Anzahl von Klicks ablaufen lassen
WebhookswebhooksArray von ZeichenfolgenPro-Link-Webhook-URLs. Siehe Webhooks.
Benachrichtige Benutzer-IDsnotify_user_idsArray von GanzzahlenWorkspace-Benutzer-IDs, die bei jedem Klick benachrichtigt werden
QR-Code-Stileqr_stylesJSON-ObjektFü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äteumleitungen

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

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 hinzu, den Sie aktualisieren möchten, sowie die Änderungen.

Verwenden Sie Metadaten, um Ihre eigenen Bezeichner für einen Link zu speichern, z. B. eine Bestell-ID, eine CRM-Kontakt-ID oder eine Kampagnenreferenz aus Ihrem eigenen System. Es ist eine Menge von Schlüssel-Wert-Paaren und wird zurückgegeben, wann immer Sie den Link abrufen und in jedem Webhook-Payload (Klick- und Link-Ereignisse), damit Sie einen Klick dem Datensatz, zu dem er gehört, zuordnen können.

Senden Sie es im JSON-Request-Body als Objekt:

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

Der Link in der Antwort enthält "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}.

Wie es funktioniert:

  • Aktualisierungen werden zusammengeführt. Wenn Sie einen Link aktualisieren, werden die Schlüssel, die Sie senden, zu den vorhandenen Metadaten des Links hinzugefügt, und Schlüssel, die Sie nicht erwähnen, bleiben unverändert. Um einen Schlüssel zu entfernen, setzen Sie ihn auf null (z. B. {"metadata": {"order_id": null}}).
  • Werte sind Zeichenfolgen. Zahlen und Boolesche Werte werden als Text gespeichert, also kommt 42 als "42" zurück. Verschachtelte Objekte und Arrays sind nicht zulässig.
  • Limits. Bis zu 20 Schlüssel pro Link, Schlüssel bis zu 40 Zeichen und Werte bis zu 500 Zeichen, genug für eine UUID.
  • Privat für Sie. Metadaten werden Personen, die auf den Link klicken, nie angezeigt, werden nicht verwendet, um die Umleitung zu erstellen, und werden nicht zur Ziel-URL hinzugefügt.
  • In der App. Sie können Metadaten auch in den Automation-Einstellungen eines Links unter Metadaten anzeigen und bearbeiten.

Metadaten, Notizen und UTM-Parameter

Metadaten, das Feld Notiz und UTM-Parameter beschreiben alle einen Link, aber sie erfüllen unterschiedliche Aufgaben:

  • Metadaten sind strukturierte Schlüssel-Wert-Daten für Ihre eigenen Systeme. Sie werden von der API zurückgegeben und in Webhooks gesendet, damit Software sie lesen kann.
  • Notiz ist ein einzelnes freies Textfeld für eine Person, um es in der App zu lesen.
  • UTM-Parameter werden zur Ziel-URL hinzugefügt, also zur Seite, auf die Sie Besucher senden, und deren Analytik, können diese sehen. Metadaten niemals. Um einen Wert an die Zielseite zu übergeben, verwenden Sie einen UTM-Parameter oder aktivieren Sie Parameter weiterleiten, damit Query-Parameter auf dem Short Link durchgeleitet werden.

Metadaten und Analytik

Metadaten werden nicht in Click-Analytics oder Click-Exporten aufgenommen, und Sie können Klicks nicht gruppieren oder filtern oder Links nach Metadaten durchsuchen. Um Klicks an Ihre eigenen Datensätze zu binden, verwenden Sie die Link-ID id. Sie erscheint in Webhook-Payloads, in Analytik aufgegliedert nach Link und in Link-Antworten. Schauen Sie entweder Ihren Datensatz von der Link-id auf Ihrer Seite nach, oder rufen Sie den Link ab, um seine Metadaten zu lesen.

Erstellen von Rotatoren über API

Um einen Rotor zu erstellen, reichen Sie ein Feld namens rules als JSON-Array zusammen mit dem Link-Payload oben ein. 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, reichen Sie ein Feld namens rules als JSON-Array zusammen mit dem Link-Payload oben ein. 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äteumleitungen über API

Um nach Gerät umzuleiten, reichen Sie ein Feld namens rules als JSON-Array zusammen mit dem Link-Payload oben ein.

Zum Beispiel:

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

Wo das Feld matches einer der folgenden Optionen ist:

  • ios
  • android
  • windows
  • linux
  • mac

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

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

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

Dann verwenden Sie das gleiche Schema wie oben für die einzelnen Link-Fälle, 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/links?api_key=API_KEY'

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

Bitte beachten Sie, dass es für eine große Anfrage bis zu 60 Sekunden dauern kann. Wenn Anfragen länger als diese Zeit dauern, schlagen sie fehl, und Sie sollten Ihre Arbeitslast in kleinere Blöcke aufteilen.

Rate Limits

Die Link-Shortening-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.