Linkly's Link Shortening API
Maak, update en beheer links programmatisch met behulp van 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 van links en het 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 in hun geheel. U kunt verifiëren dat ze voor u werken.
- 3Vraag ChatGPT of iets gelijkaardigs 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 API-aanvragen automatisch 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, wat verder gaat dan wat hieronder wordt geboden. Dezelfde eindpunten zijn ook beschikbaar als een Postman-verzameling met één klik.
Autorisatie
U hebt nodig:
- Uw API-sleutel
- Workspace-ID
U kunt deze details in Linkly ophalen.
- 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 te sturen naar:
https://app.linklyhq.com/api/v1/link
met de volgende velden in de tekst.
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 | Notes |
|---|---|---|---|
| Account API Key | api_key | String | Vereist |
| Workspace ID | workspace_id | Integer | Vereist |
| Link ID | id | Integer | Vereist bij het bijwerken van bestaande link |
| Destination | url | String | Vereist |
| 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 | Stuurt referrer-policy: no-referrer zodat de bestemming Linkly niet in de referer-header ziet |
| Cloaking | cloaking | Boolean | Maskeert 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 aanstaat, laat social crawlers toch door zodat OG-previews 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 | Vereist als slug is opgegeven. Zie custom domains |
| Custom Domain Suffix | slug | String | Als domein is opgegeven en slug null is, wordt het automatisch gegenereerd |
| Open Graph Title | og_title | String | Voor previews op social media |
| Open Graph Description | og_description | String | Voor previews op social media |
| Open Graph Image URL | og_image | String | Voor previews op social media |
| 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 | Door newlines gescheiden zinnen die automatisch moeten worden ingekort op landingspagina's |
| Replacements | replacements | String | Tekstvervanging regels toegepast op de bestemmingspagina |
| Expiry DateTime | expiry_datetime | ISO8601 DateTime String | Voor verlooende links |
| Expiry Destination | expiry_destination | String (URL) | Voor verlooende links. Moet beginnen met http. |
| Expiry Clicks | expiry_clicks | Integer | Link verlopen na dit aantal klikken |
| Webhooks | webhooks | Array of strings | Per-link webhook URL's. Zie webhooks. |
| Notify User IDs | notify_user_ids | Array of integers | Workspace-gebruikers-ID's 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 |
Voorbeeld aanvraag met cURL
De onderstaande code illustreert hoe u een API-aanvraag maakt 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 reactie 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 die u zou gebruiken om een link te maken, maar voeg u het veld id in voor de link die u wilt bijwerken, plus de wijzigingen.
Rotators maken via API
Om een rotator te maken, dient u een veld in genaamd rules als een JSON-array, samen met de link-payload hierboven. U moet application/json gebruiken om JSON-arrays te verzenden.
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 om te leiden per land, dient u een veld in genaamd rules als een JSON-array, samen met de link-payload hierboven. U moet application/json codering gebruiken om JSON-arrays te verzenden.
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 om te leiden per apparaat, dient u een veld in genaamd rules als een JSON-array, samen met de link-payload hierboven.
Bijvoorbeeld:
[
{"what": "platform", "url": "https://www.google.com", "matches": "windows"},
{"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]
Waarbij het veld matches één 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.
Daarvoor dient u uw API-sleutel als volgt in te dienen:
https://app.linklyhq.com/api/v1/link?api_key=XXXXXXXXXXX
Gebruik vervolgens hetzelfde schema als hierboven voor de individuele link-gevallen, maar verpak de link-aanvragen in een array van het formulier:
[{link}, {link}]
Hier is een volledige aanvraag die twee links zal bijwerken:
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'
Dit werkt voor zowel het maken als 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 werkbelasting in kleinere delen verdelen.
Snelheidslimieten
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 klikgegevens en verkeersrapporten
- Webhooks - Real-time klikmeldingen
- Zapier Integration - No-code integraties
Beschikbaarheid per plan
Inbegrepen in elk plan
Track 500 maandelijkse klikken gratis.