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 die Link-Erstellung und die Link-Aktualisierung.
Sparen Sie Zeit und lassen Sie uns die schwere Arbeit machen:
- 1Siehe unten für API-Anfragen zur Link-Erstellung.
- 2Kopieren Sie die Anfragen vollständig. Sie können überprüfen, ob sie für Sie funktionieren.
- 3Fragen 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 API-Anfragen automatisch basierend auf dem Inhalt des Formulars. Sie können den hier angegebenen 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 Endpunkte sind auch als One-Click-Postman-Sammlung verfügbar.
OpenAPI-Spezifikation anzeigen
Autorisierung
Sie benötigen:
- Ihren API-Schlüssel
- Workspace-ID
Sie können diese Details in Linkly abrufen.
- 1Melden Sie sich bei Linkly an.
- 2Klicken Sie auf Einstellungen.
- 3Klicken Sie auf API-Schlüssel.
Erstellen oder Aktualisieren eines Links
Um einen Link zu erstellen, müssen Sie nur eine POST-Anfrage an folgende Adresse senden:
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 Rules einreichen, müssen Sie application/json verwenden.
Wir empfehlen, JSON mit der Open-API-Spezifikation zu verwenden.
| Label | Key | Type | Notes |
|---|---|---|---|
| Account-API-Schlüssel | api_key | String | Erforderlich |
| Workspace-ID | workspace_id | Integer | Erforderlich |
| Link-ID | id | Integer | Erforderlich, wenn Sie einen vorhandenen Link aktualisieren |
| Ziel | url | String | Erforderlich |
| Spitzname | name | String | |
| Notizen | note | String | |
| Retargeting-Tags (Head-Bereich) | head_tags | String | Für Retargeting-Pixel |
| Retargeting-Tags (Body-Bereich) | body_tags | String | Für Retargeting-Pixel |
| Parameter weitergeben | forward_params | Boolean | |
| Referrer verbergen | hide_referrer | Boolean | Sendet referrer-policy: no-referrer, sodass das Ziel Linkly nicht im Referrer-Header sieht |
| Maskierung | cloaking | Boolean | Verbirgt die Ziel-URL hinter einem Frame |
| Bots blockieren | block_bots | Boolean | Blockiert bekannte Bots/Crawler |
| Social-Crawler-Tracking überspringen | skip_social_crawler_tracking | Boolean | Wenn block_bots aktiviert ist, lassen Sie Social-Crawler weiterhin durch, damit OG-Vorschauen funktionieren |
| Öffentliche Analytik | public_analytics | Boolean | Aktiviert die öffentliche Seite /abc123.stats für diesen Link |
| Passwort | password | String | Besucher müssen dieses Passwort eingeben, bevor die Umleitung erfolgt |
| Veröffentlichungsstatus | enabled | Boolean | |
| UTM-Quelle | utm_source | String | Für UTM-Tracking |
| UTM-Medium | utm_medium | String | Für UTM-Tracking |
| UTM-Kampagne | utm_campaign | String | Für UTM-Tracking |
| UTM-Begriff | utm_term | String | Für UTM-Tracking |
| UTM-Inhalt | utm_content | String | Für UTM-Tracking |
| Benutzerdefinierte Domäne | domain | String | Erforderlich, wenn Slug angegeben ist. Siehe benutzerdefinierte Domänen |
| Benutzerdefiniertes Domänensuffix | slug | String | Wenn Domäne angegeben und Slug null ist, wird automatisch generiert |
| Open-Graph-Titel | og_title | String | Für Social-Media-Vorschauen |
| Open-Graph-Beschreibung | og_description | String | Für Social-Media-Vorschauen |
| Open-Graph-Bild-URL | og_image | String | Für Social-Media-Vorschauen |
| Meta-Pixel-ID | fb_pixel_id | String | Für Meta-Pixel |
| TikTok-Pixel-ID | tiktok_pixel_id | String | |
| Google Analytics 4-ID | ga4_tag_id | String | |
| Google Tag Manager-Container | gtm_id | String | |
| Wörter verlinkifizieren | linkify_words | String | Zeilenumbruch-getrennte Phrasen, die auf Landingpages automatisch gekürzt werden sollen |
| Ersetzungen | replacements | String | Textersetzungsregeln für die Zielseite |
| Ablaufdatum/-zeit | expiry_datetime | ISO8601-DateTime-String | Für ablaufende Links |
| Ablaufziel | expiry_destination | String (URL) | Für ablaufende Links. Muss mit http beginnen. |
| Ablauf-Klicks | expiry_clicks | Integer | Link nach dieser Anzahl von Klicks ablaufen lassen |
| Webhooks | webhooks | Array von Strings | Pro-Link-Webhook-URLs. Siehe Webhooks. |
| Benutzer-IDs benachrichtigen | notify_user_ids | Array von Ganzzahlen | Workspace-Benutzer-IDs, die bei jedem Klick benachrichtigt werden |
| QR-Code-Stile | qr_styles | JSON-Objekt | Für QR-Code-Styling. Keys: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| Regeln | rules | JSON-Array | Für Rotators, Geo-Umleitungen und Geräte-Umleitungen |
Beispiel-Anfrage 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
}
Aktualisierung eines Links
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.
Erstellen von Rotatoren über die API
Um einen Rotator zu erstellen, senden Sie ein Feld namens rules als JSON-Array zusammen mit der Link-Nutzlast oben. 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 die API
Um nach Land umzuleiten, senden Sie ein Feld namens rules als JSON-Array zusammen mit der Link-Nutzlast oben. Sie müssen die 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 die API
Um nach Gerät umzuleiten, senden Sie ein Feld namens rules als JSON-Array zusammen mit der Link-Nutzlast oben.
Zum Beispiel:
[
{"what": "platform", "url": "https://www.google.com", "matches": "windows"},
{"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]
Dabei ist das Feld matches eines der folgenden:
- ios
- android
- windows
- linux
- mac
Erstellen oder Aktualisieren mehrerer Links in einer Anfrage
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 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/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 erwägen, Ihre Arbeitslast in kleinere Teile zu unterteilen.
Ratenlimits
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 einzigen Anfrage hochladen.
Verwandt
- Analytics-API - Exportieren Sie Klickdaten und Verkehrsberichte
- Webhooks - Echtzeit-Klickbenachrichtigungen
- Zapier-Integration - Codelose Integrationen
Tarifverfügbarkeit
Enthalten in jedem Tarif
Verfolgen Sie 500 monatliche Klicks kostenlos.