Linkly's Link Shortening API
Maak, werk bij en beheer links programmatisch met Linkly's Link Shortening API.
Gerelateerd: Analytics API | Webhooks
Voordat u begint
Linkly genereert API-aanvragen in de interface die u kunt kopiëren en plakken in uw applicaties.
Dit werkt voor het maken en bijwerken van links.
Bespaar tijd en laat ons het zware werk doen:
- 1Zie hieronder voor API-aanvragen voor het maken van links.
- 2Kopieer de aanvragen volledig. U kunt controleren of ze voor u werken.
- 3Vraag ChatGPT of iets soortgelijks om deze aanvragen aan te passen in broncode voor uw applicatie. U hoeft geen tijd te besteden aan een complexe integratie. Onze API is volledig machine-consumable.
OpenAPI 3.0-spec
U kunt API-aanvragen rechtstreeks genereren vanuit de Linkly-gebruikersinterface.
Linkly's Link Shortening API Builder
Linkly's link shortening API bouwt automatisch API-aanvragen op basis van de inhoud van het formulier. U kunt de hier gegeven tekst in elke LLM plakken om automatisch code voor uw applicatie te genereren.
Linkly's API is gedocumenteerd met behulp van de OpenAPI-standaard, die verder gaat dan wat hieronder is gegeven. Dezelfde endpoints zijn ook beschikbaar als een één-klik Postman-collectie.
Autorisatie
U hebt nodig:
- Uw API-sleutel
- Workspace-ID
U kunt deze details in Linkly vinden.
- 1Log in bij Linkly.
- 2Klik op Instellingen.
- 3Klik op API-sleutels.
Een link maken of bijwerken
Om een link te maken, hoeft u alleen maar een POST-aanvraag in te dienen bij:
https://app.linklyhq.com/api/v1/link
met de volgende velden in de body.
Het coderingstype is x-www-form-urlencoded of application/json.
Als u het veld Rules indient, moet u application/json gebruiken.
We raden u aan JSON te gebruiken met de Open API spec.
| Label | Key | Type | Opmerkingen |
|---|---|---|---|
| Account API Key | api_key | String | Verplicht |
| Workspace ID | workspace_id | Integer | Verplicht |
| Link ID | id | Integer | Verplicht bij bijwerken van bestaande link |
| Destination | url | String | Verplicht |
| Nickname | name | String | |
| Notes | note | String | |
| Retargeting tags (head region) | head_tags | String | Voor retargeting pixels |
| Retargeting tags (body region) | body_tags | String | Voor retargeting pixels |
| Forward Params | forward_params | Boolean | |
| Hide Referrer | hide_referrer | Boolean | Verzendt referrer-policy: no-referrer zodat de bestemming Linkly niet in de referer header ziet |
| Cloaking | cloaking | Boolean | Verbergt de doel-URL achter een frame |
| Block Bots | block_bots | Boolean | Blokkeert bekende bots/crawlers |
| Skip Social Crawler Tracking | skip_social_crawler_tracking | Boolean | Wanneer block_bots is ingeschakeld, laat social crawlers nog steeds door zodat OG-voorbeelden werken |
| Public Analytics | public_analytics | Boolean | Schakelt de openbare /abc123.stats pagina voor deze link in |
| Password | password | String | Bezoekers moeten dit wachtwoord invoeren voordat ze worden omgeleid |
| Publishing Status | enabled | Boolean | |
| UTM Source | utm_source | String | Voor UTM tracking |
| UTM Medium | utm_medium | String | Voor UTM tracking |
| UTM Campaign | utm_campaign | String | Voor UTM tracking |
| UTM Term | utm_term | String | Voor UTM tracking |
| UTM Content | utm_content | String | Voor UTM tracking |
| Custom Domain | domain | String | Verplicht als slug is opgegeven. Zie custom domains |
| Custom Domain Suffix | slug | String | Als domain is opgegeven en slug is null, wordt het automatisch gegenereerd |
| Open Graph Title | og_title | String | Voor social media previews |
| Open Graph Description | og_description | String | Voor social media previews |
| Open Graph Image URL | og_image | String | Voor social media previews |
| Meta Pixel ID | fb_pixel_id | String | Voor Meta Pixel |
| TikTok Pixel ID | tiktok_pixel_id | String | |
| Google Analytics 4 ID | ga4_tag_id | String | |
| Google Tag Manager container | gtm_id | String | |
| Linkify Words | linkify_words | String | Met nieuwe regel gescheiden zinnen die automatisch moeten worden ingekort op landingspagina's |
| Replacements | replacements | String | Tekstvervangende regels toegepast op de doelpagina |
| Expiry DateTime | expiry_datetime | ISO8601 DateTime String | Voor expiring links |
| Expiry Destination | expiry_destination | String (URL) | Voor expiring links. Moet beginnen met http. |
| Expiry Clicks | expiry_clicks | Integer | Link verlopen na dit aantal kliks |
| Webhooks | webhooks | Array of strings | Per-link webhook URLs. Zie webhooks. |
| Notify User IDs | notify_user_ids | Array of integers | Workspace user IDs om op elke klik op de hoogte te stellen |
| QR Code Styles | qr_styles | JSON object | Voor QR code styling. Keys: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| Rules | rules | JSON array | Voor rotators, geo-redirects, en device redirects |
Voorbeeldaanvraag met curl
De onderstaande code illustreert hoe u een API-aanvraag indient 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 succesvolle respons retourneert een JSON-object dat de link vertegenwoordigt, samen met een 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
}
Een link bijwerken
Om een link bij te werken, stuurt u dezelfde aanvraag als u zou gebruiken om een link te maken, maar voegt u het veld id toe voor de link die u wilt bijwerken, evenals de wijzigingen.
Rotators maken via API
Om een rotator te maken, dient u een veld genaamd rules in als een JSON-array, samen met de linkpayload hierboven. U moet application/json gebruiken om JSON-arrays in te dienen.
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 per land om te leiden, dient u een veld genaamd rules in als een JSON-array, samen met de linkpayload hierboven. U moet application/json codering gebruiken om JSON-arrays in te dienen.
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 per apparaat om te leiden, dient u een veld genaamd rules in als een JSON-array, samen met de linkpayload hierboven.
Bijvoorbeeld:
[
{"what": "platform", "url": "https://www.google.com", "matches": "windows"},
{"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]
Waarbij het veld matches een van de volgende is:
- ios
- android
- windows
- linux
- mac
Meerdere links in één aanvraag maken of bijwerken
Linkly ondersteunt het maken/wijzigen van tot 1000 links per aanvraag.
Om dit te doen, dient u uw API-sleutel als volgt in als onderdeel van de aanvraag:
https://app.linklyhq.com/api/v1/links?api_key=XXXXXXXXXXX
Gebruik vervolgens hetzelfde schema als hierboven voor de afzonderlijke linkcases, maar verpak de linkaanvragen in een array van de vorm:
[{link}, {link}]
Hier is een volledige aanvraag waarmee twee links worden bijgewerkt:
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 het maken als het bijwerken van acties.
Houd er rekening mee dat het tot 60 seconden kan duren voordat een grote aanvraag wordt verwerkt. Als aanvragen langer duren, mislukken ze, en moet u uw workload in kleinere chunks verdelen.
Rate limits
De link shortening API is beperkt tot 20 aanvragen/seconde. Tot 200 aanvragen per seconde zijn op aanvraag beschikbaar. U kunt tot 1000 links in één aanvraag uploaden.
Gerelateerd
- Analytics API - Exporteer clickdata en verkeersrapporten
- Webhooks - Real-time click-meldingen
- Zapier Integration - No-code integraties
Beschikbaarheid per plan
Inbegrepen in elk plan
Track 500 maandelijkse klikken gratis.