API Skracania Linków Linkly
Twórz, aktualizuj i zarządzaj linkami programowo, używając API Skracania Linków Linkly.
Pokrewne: API Analityki | Webhooks
Zanim zaczniesz
Linkly generuje żądania API w interfejsie, które możesz skopiować i wkleić do swoich aplikacji.
Działa to przy tworzeniu i aktualizacji linków.
Zaoszczędź czas i pozwól nam wykonać ciężką pracę:
- 1Poniżej znajdziesz żądania API do tworzenia linków.
- 2Skopiuj żądania w całości. Możesz sprawdzić, że działają dla Ciebie.
- 3Poproś ChatGPT lub równoważny system, aby dostosował te żądania do kodu źródłowego Twojej aplikacji. Nie ma potrzeby spędzania czasu na skomplikowanej integracji. Nasze API jest w pełni konsumowalne maszynowo.
Specyfikacja OpenAPI 3.0
Możesz generować żądania API bezpośrednio z interfejsu użytkownika Linkly.
Konstruktor API Skracania Linków Linkly
API skracania linków Linkly automatycznie buduje żądania API na podstawie zawartości formularza. Możesz wkleić podany tutaj tekst do dowolnego LLM, aby automatycznie wygenerować kod dla Twojej aplikacji.
API Linkly jest dokumentowane przy użyciu standardu OpenAPI, który wykracza poza to, co podano poniżej. Te same punkty końcowe są również dostępne jako kolekcja Postmana jednym klikiem.
Autoryzacja
Będziesz potrzebować:
- Twój Klucz API
- ID Workspace
Możesz uzyskać te szczegóły z wnętrza Linkly.
- 1Zaloguj się do Linkly.
- 2Kliknij Ustawienia.
- 3Kliknij Klucze API.
Tworzenie lub aktualizacja linku
Aby utworzyć link, wystarczy wysłać żądanie POST do:
https://app.linklyhq.com/api/v1/link
z poniższymi polami w treści.
Typ kodowania to x-www-form-urlencoded lub application/json.
Jeśli przesyłasz pole Rules, musisz użyć application/json.
Zalecamy używanie JSON ze specyfikacją Open API.
| Etykieta | Klucz | Typ | Notatki |
|---|---|---|---|
| Klucz API Konta | api_key | String | Wymagane |
| ID Workspace | workspace_id | Integer | Wymagane |
| ID Linku | id | Integer | Wymagane przy aktualizacji istniejącego linku |
| Cel | url | String | Wymagane |
| Pseudonim | name | String | |
| Notatki | note | String | |
| Znaczniki retargetingowe (region head) | head_tags | String | Dla pikseli retargetingowych |
| Znaczniki retargetingowe (region body) | body_tags | String | Dla pikseli retargetingowych |
| Przekazuj Parametry | forward_params | Boolean | |
| Ukryj Odsyłającego | hide_referrer | Boolean | Wysyła referrer-policy: no-referrer, aby cel nie widział Linkly w nagłówku referer |
| Maskowanie | cloaking | Boolean | Maskuje docelowy adres URL za ramką |
| Blokuj Boty | block_bots | Boolean | Blokuje znane boty/crawlery |
| Pomiń Śledzenie Social Crawler | skip_social_crawler_tracking | Boolean | Gdy block_bots jest włączony, pozwól crawlerom społecznym przejść, aby podglądy OG działały |
| Publiczna Analityka | public_analytics | Boolean | Włącza publiczną stronę /abc123.stats dla tego linku |
| Hasło | password | String | Odwiedzający muszą wpisać to hasło przed przekierowaniem |
| Status Publikacji | enabled | Boolean | |
| Źródło UTM | utm_source | String | Dla śledzenia UTM |
| Medium UTM | utm_medium | String | Dla śledzenia UTM |
| Kampania UTM | utm_campaign | String | Dla śledzenia UTM |
| Termin UTM | utm_term | String | Dla śledzenia UTM |
| Zawartość UTM | utm_content | String | Dla śledzenia UTM |
| Domena Niestandardowa | domain | String | Wymagane, jeśli podano slug. Patrz domeny niestandardowe |
| Sufiks Domeny Niestandardowej | slug | String | Jeśli domena jest podana a slug jest null, zostanie autogenerowany |
| Tytuł Open Graph | og_title | String | Dla podglądów mediów społecznych |
| Opis Open Graph | og_description | String | Dla podglądów mediów społecznych |
| Adres URL Obrazu Open Graph | og_image | String | Dla podglądów mediów społecznych |
| ID Meta Pixel | fb_pixel_id | String | Dla Meta Pixel |
| ID Pikselu TikTok | tiktok_pixel_id | String | |
| ID Google Analytics 4 | ga4_tag_id | String | |
| Kontener Google Tag Manager | gtm_id | String | |
| Linkify Słów | linkify_words | String | Frazy oddzielone nową linią, które powinny być auto-skracane na stronach docelowych |
| Zamiany | replacements | String | Reguły zamiany tekstu zastosowane do strony docelowej |
| Czas Wygaśnięcia | expiry_datetime | Ciąg ISO8601 DateTime | Dla linków wygasających |
| Cel Wygaśnięcia | expiry_destination | String (URL) | Dla linków wygasających. Musi zaczynać się od http. |
| Kliknięcia Wygaśnięcia | expiry_clicks | Integer | Wygaś link po tej liczbie kliknięć |
| Webhooks | webhooks | Tablica ciągów | Adresy URL webhooków dla każdego linku. Patrz webhooks. |
| Powiadom ID Użytkowników | notify_user_ids | Tablica liczb całkowitych | ID użytkowników workspace do powiadomienia przy każdym kliknięciu |
| Style Kodów QR | qr_styles | Obiekt JSON | Dla stylizacji kodów QR. Klucze: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| Reguły | rules | Tablica JSON | Dla rotatorów, geo-przekierowań i przekierowań urządzeń |
Przykładowe żądanie przy użyciu curl
Kod poniżej ilustruje, jak wykonać żądanie API w celu utworzenia linku.
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'
Pomyślna odpowiedź zwróci obiekt JSON reprezentujący link, wraz z id linku.
{
"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
}
Aktualizacja linku
Aby zaktualizować link, wyślij to samo żądanie, które użyłbyś do utworzenia linku, ale dołącz pole id dla linku, który chcesz zaktualizować, wraz ze zmianami.
Tworzenie rotatorów za pośrednictwem API
Aby utworzyć rotator, prześlij pole o nazwie rules jako tablicę JSON, wraz z powyższym ładunkiem linku. Musisz użyć application/json, aby wysłać tablice JSON.
Na przykład:
[
{"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
{"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]
Tworzenie geo-przekierowań za pośrednictwem API
Aby dokonać przekierowania według kraju, prześlij pole o nazwie rules jako tablicę JSON, wraz z powyższym ładunkiem linku. Musisz użyć kodowania application/json, aby wysłać tablice JSON.
Na przykład:
[
{"what": "country", "url": "https://www.microsoft.com", "matches": "UK"},
{"what": "country", "url": "https://www.apple.com", "matches": "US"}
]
Kraj to dwuliterowy kod kraju ISO 3166.
Tworzenie przekierowań urządzeń za pośrednictwem API
Aby dokonać przekierowania według urządzenia, prześlij pole o nazwie rules jako tablicę JSON, wraz z powyższym ładunkiem linku.
Na przykład:
[
{"what": "platform", "url": "https://www.google.com", "matches": "windows"},
{"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]
Gdzie pole matches to jedno z:
- ios
- android
- windows
- linux
- mac
Tworzenie lub aktualizacja wielu linków w jednym żądaniu
Linkly obsługuje tworzenie/zmianę do 1000 linków na żądanie.
Aby to zrobić, prześlij swój klucz API w ramach żądania w następujący sposób:
https://app.linklyhq.com/api/v1/link?api_key=XXXXXXXXXXX
Następnie użyj tego samego schematu co w powyższych przypadkach poszczególnych linków, ale zawiń żądania linków w tablicę postaci:
[{link}, {link}]
Oto kompletne żądanie, które zaktualizuje dwa linki:
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'
Działa to zarówno dla akcji tworzenia, jak i aktualizacji.
Pamiętaj, że duże żądania mogą zająć do 60 sekund. Jeśli żądania trwają dłużej, będą się nie powieść, i powinieneś rozdzielić pracę na mniejsze części.
Limity szybkości
API skracania linków jest ograniczone do 20 żądań/sekundę. Do 200 żądań na sekundę są dostępne na życzenie. Możesz przesłać do 1000 linków w jednym żądaniu.
Pokrewne
- API Analityki - Eksportuj dane kliknięć i raporty ruchu
- Webhooks - Powiadomienia kliknięć w czasie rzeczywistym
- Integracja Zapier - Integracje bez kodu
Dostępność planu
Zawarte w każdym planie
Śledź 500 kliknięć miesięcznie za darmo.