API skracania linków Linkly
Twórz, aktualizuj i zarządzaj linkami programowo, korzystając z API skracania linków Linkly.
Powiązane: Analytics API | 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ć pracę:
- 1Poniżej znajdują się żądania API do tworzenia linków.
- 2Skopiuj żądania w całości. Możesz sprawdzić, czy działają dla Ciebie.
- 3Poproś ChatGPT lub równoważne narzędzie, aby dostosowało te żądania do kodu źródłowego Twojej aplikacji. Nie ma potrzeby spędzać czasu na złożonej integracji. Nasze API jest całkowicie zużywalne maszynowo.
Specyfikacja OpenAPI 3.0
Możesz generować żądania API bezpośrednio z interfejsu użytkownika Linkly.
Kreator API skracania linków Linkly
API skracania linków Linkly automatycznie buduje żądania API na podstawie zawartości formularza. Tekst podany tutaj możesz wkleić 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 Postman jednym kliknięciem.
Autoryzacja
Będziesz potrzebować:
- Twojego klucza API
- ID obszaru roboczego
Te szczegóły możesz uzyskać z poziomu Linkly.
- 1Zaloguj się do Linkly.
- 2Kliknij Ustawienia.
- 3Kliknij Klucze API.
Tworzenie lub aktualizowanie linku
Aby utworzyć link, wystarczy wysłać żądanie POST na adres:
https://app.linklyhq.com/api/v1/link
z następującymi 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życie JSON ze specyfikacją Open API.
| Etykieta | Klucz | Typ | Notatki |
|---|---|---|---|
| Klucz API konta | api_key | String | Wymagane |
| ID obszaru roboczego | workspace_id | Integer | Wymagane |
| ID linku | id | Integer | Wymagane jeśli aktualizujesz istniejący link |
| Miejsce docelowe | url | String | Wymagane |
| Pseudonim | name | String | |
| Notatki | note | String | |
| Tagi retargetingu (region head) | head_tags | String | Dla pikseli retargetingu |
| Tagi retargetingu (region body) | body_tags | String | Dla pikseli retargetingu |
| Parametry do przodu | forward_params | Boolean | |
| Ukryj adres referrera | hide_referrer | Boolean | Wysyła referrer-policy: no-referrer, aby miejsce docelowe nie widziało Linkly w nagłówku referer |
| Maskowanie | cloaking | Boolean | Maskuje adres URL miejsca docelowego za ramką |
| Blokuj boty | block_bots | Boolean | Blokuje znane boty/crawlery |
| Pomiń śledzenie crawlerów mediów społecznych | skip_social_crawler_tracking | Boolean | Gdy block_bots jest włączony, pozwól jednak crawlerom mediów społecznych, aby podglądy OG działały |
| Analityka publiczna | 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 |
| Środek 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 ma wartość null, będzie auto-generowany |
| 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 piksela Meta | fb_pixel_id | String | Dla Meta Pixel |
| ID piksela TikTok | tiktok_pixel_id | String | |
| ID Google Analytics 4 | ga4_tag_id | String | |
| Kontener Google Tag Manager | gtm_id | String | |
| Linkify Words | linkify_words | String | Wyrażenia oddzielone znakami nowego wiersza, które powinny być auto-skracane na stronach docelowych |
| Zamiany | replacements | String | Reguły zamiany tekstu zastosowane do strony docelowej |
| Data/godzina wygaśnięcia | expiry_datetime | Ciąg ISO8601 DateTime | Dla linków wygasających |
| Miejsce docelowe 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 tylu kliknięciach |
| Webhooks | webhooks | Array of strings | Adresy URL webhooków dla każdego linku. Patrz webhooks. |
| Powiadom ID użytkowników | notify_user_ids | Array of integers | ID użytkowników obszaru roboczego, którzy mają być powiadamiani o każdym kliknięciu |
| Style kodu QR | qr_styles | JSON object | Dla stylizacji kodu QR. Klucze: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| Reguły | rules | JSON array | Dla rotatorów, przekierowań geo i przekierowań urządzeń |
Przykładowe żądanie przy użyciu curl
Poniższy kod 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
}
Aktualizowanie linku
Aby zaktualizować link, wyślij takie samo żądanie, które byś użył do utworzenia linku, ale dołącz pole id dla linku, który chcesz zaktualizować, oraz zmiany.
Tworzenie rotatorów za pośrednictwem API
Aby utworzyć rotator, prześlij pole o nazwie rules jako tablica JSON, wraz z powyższym ładunkiem linku. Musisz użyć application/json do wysyłania tablic JSON.
Na przykład:
[
{"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
{"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]
Tworzenie przekierowań geo za pośrednictwem API
Aby przekierować według kraju, prześlij pole o nazwie rules jako tablica JSON, wraz z powyższym ładunkiem linku. Musisz użyć kodowania application/json do wysyłania tablic JSON.
Na przykład:
[
{"what": "country", "url": "https://www.microsoft.com", "matches": "UK"},
{"what": "country", "url": "https://www.apple.com", "matches": "US"}
]
Krajem jest dwuliterowy kod kraju ISO 3166.
Tworzenie przekierowań urządzeń za pośrednictwem API
Aby przekierować według urządzenia, prześlij pole o nazwie rules jako tablica 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 jeden z:
- ios
- android
- windows
- linux
- mac
Tworzenie lub aktualizowanie 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 jako część żą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 powyżej dla poszczególnych przypadków linków, ale zawiń żądania linków w tablicę postaci:
[{link}, {link}]
Oto kompletne żądanie, które będzie aktualizować 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, nie powiedzie się i powinieneś rozdzielić swoje obciążenie 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 żądanie. Możesz przesłać do 1000 linków w jednym żądaniu.
Powiązane
- Analytics API - 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.