API skracania linków Linkly
Twórz, aktualizuj i zarządzaj linkami programowo, używając API skracania linków Linkly.
Pokrewne: Analytics API | Webhooks
Zanim zaczniesz
Linkly generuje żądania API w interfejsie, które możesz skopiować i wkleić do swoich aplikacji.
To działa zarówno do tworzenia linków, jak 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ć, czy działają dla Ciebie.
- 3Poproś ChatGPT lub równoważny program, aby dostosował te żądania do kodu źródłowego Twojej aplikacji. Nie ma potrzeby spędzać czasu na skomplikowanej integracji. Nasz API jest całkowicie konsumowalne maszynowo.
Specyfikacja OpenAPI 3.0
Możesz generować żądania API bezpośrednio z interfejsu użytkownika Linkly.
Konstruktor API skracania linków Linkly
Konstruktor API skracania linków Linkly automatycznie buduje żądania API na podstawie zawartości formularza. Możesz wkleić tutaj podany tekst do dowolnego LLM, aby automatycznie wygenerować kod dla Twojej aplikacji.
API Linkly jest dokumentowane za pomocą standardu OpenAPI, który wykracza poza to, co podano poniżej. Te same punkty końcowe są również dostępne jako jednoklikowa kolekcja Postmana.
Autoryzacja
Będziesz potrzebować:
- Twojego klucza API
- ID obszaru roboczego
Możesz uzyskać te szczegóły z wewnątrz Linkly.
- 1Zaloguj się do Linkly.
- 2Kliknij Ustawienia.
- 3Kliknij Klucze API.
Tworzenie lub aktualizowanie linku
Aby utworzyć link, wystarczy wysłać żądanie POST do:
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 w przypadku aktualizacji istniejącego linku |
| Przeznaczenie | url | String | Wymagane |
| Pseudonim | name | String | |
| Notatki | note | String | |
| Znaczniki retargetowania (obszar head) | head_tags | String | Dla pikseli retargetowania |
| Znaczniki retargetowania (obszar body) | body_tags | String | Dla pikseli retargetowania |
| Parametry przesyłania dalej | forward_params | Boolean | |
| Ukryj odsyłacz | hide_referrer | Boolean | Wysyła referrer-policy: no-referrer, aby miejsce docelowe nie widziało Linkly w nagłówku referer |
| Maskowanie | cloaking | Boolean | Ukrywa 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, nadal zezwalaj 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 |
| 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 podana jest slug. Patrz domeny niestandardowe |
| Sufiks domeny niestandardowej | slug | String | Jeśli domena jest podana i slug ma wartość null, będzie generowany automatycznie |
| 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 TikTok Pixel | tiktok_pixel_id | String | |
| ID Google Analytics 4 | ga4_tag_id | String | |
| Kontener Google Tag Manager | gtm_id | String | |
| Linkify Words | linkify_words | String | Frazy oddzielone znakami nowego wiersza, które powinny być automatycznie skracane na stronach docelowych |
| Zamiany | replacements | String | Reguły zamiany tekstu stosowane do strony docelowej |
| Data/godzina wygaśnięcia | expiry_datetime | ISO8601 DateTime String | Dla linków wygasających |
| Docelowy URL 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 | Array of strings | Adresy URL webhooków specyficzne dla linku. Patrz webhooks. |
| Powiadom ID użytkowników | notify_user_ids | Array of integers | ID użytkowników obszaru roboczego do powiadomienia przy każdym kliknięciu |
| Style kodu QR | qr_styles | JSON object | Dla stylów kodu QR. Klucze: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| Reguły | rules | JSON array | Dla rotatorów, geo-przekierowań i przekierowań urządzeń |
Przykładowe żądanie przy użyciu curl
Poniższy kod ilustruje sposób wykonania żądania 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 to samo żądanie, które byś użył 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 zwane rules jako tablicę JSON, wraz z ładunkiem linku powyżej. 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 geo-przekierowań za pośrednictwem API
Aby przekierować według kraju, prześlij pole zwane rules jako tablicę JSON, wraz z ładunkiem linku powyżej. 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 zwane rules jako tablicę JSON, wraz z ładunkiem linku powyżej.
Na przykład:
[
{"what": "platform", "url": "https://www.google.com", "matches": "windows"},
{"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]
Gdzie pole matches jest jednym z:
- ios
- android
- windows
- linux
- mac
Tworzenie lub aktualizowanie wielu linków w jednym żądaniu
Linkly obsługuje tworzenie/modyfikowanie 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/links?api_key=XXXXXXXXXXX
Następnie użyj tego samego schematu co powyżej dla poszczególnych przypadków linków, ale opakuj żądania linków w tablicę w 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/links?api_key=API_KEY'
To działa zarówno do tworzenia, jak i aktualizacji.
Pamiętaj, że duże żądanie może potrwać do 60 sekund. Jeśli żądania potrwają dłużej, nie powiodą się i powinieneś podzielić swoją pracę na mniejsze części.
Limity szybkości
API skracania linków jest ograniczone do 20 żądań/sekunda. Do 200 żądań na sekundę są dostępne na życzenie. Możesz przesłać do 1000 linków w jednym żądaniu.
Pokrewne
- Analytics API - Eksportuj dane kliknięć i raporty o ruchu
- Webhooks - Powiadomienia o kliknięciach w czasie rzeczywistym
- Integracja Zapier - Integracje bez kodu
Dostępność planu
Zawarte w każdym planie
Śledź 500 kliknięć miesięcznie za darmo.