API skracania linków Linkly

Twórz, aktualizuj i zarządzaj linkami programowo za pomocą API skracania linków Linkly.

Powiązane: Analytics API | Webhooks

Przed rozpoczęciem

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ć trudną pracę:

  1. 1
    Poniżej znajdziesz żądania API do tworzenia linków.
  2. 2
    Skopiuj żądania w całości. Możesz sprawdzić, czy działają dla Ciebie.
  3. 3
    Poproś ChatGPT lub równoważne narzędzie, aby dostosowało te żądania do kodu źródłowego Twojej aplikacji. Nie ma potrzeby spędzania czasu na złożonej integracji. Nasze API jest w pełni maszynowo konsumowalne.

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 otrzymany 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.

Autoryzacja

Będziesz potrzebować:

  • Twojego klucza API
  • ID Workspace

Możesz uzyskać te szczegóły w aplikacji Linkly.

  1. 1
    Zaloguj się do Linkly.
  2. 2
    Kliknij Ustawienia.
  3. 3
    Kliknij 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 żądania.

Typ kodowania to x-www-form-urlencoded lub application/json.

Jeśli przesyłasz pole Rules, musisz użyć application/json.

Rekomendujemy użycie JSON z specyfikacją Open API.

EtykietaKluczTypUwagi
Klucz API kontaapi_keyStringWymagane
ID Workspaceworkspace_idIntegerWymagane
ID linkuidIntegerWymagane w przypadku aktualizacji istniejącego linku
Cel docelowyurlStringWymagane
NazwanameString
NotatkinoteString
Tagi retargetingu (region head)head_tagsStringDla pikseli retargetingu
Tagi retargetingu (region body)body_tagsStringDla pikseli retargetingu
Parametry Forwardforward_paramsBoolean
Status publikacjienabledBoolean
Źródło UTMutm_sourceStringDla śledzenia UTM
Środek UTMutm_mediumStringDla śledzenia UTM
Kampania UTMutm_campaignStringDla śledzenia UTM
Termin UTMutm_termStringDla śledzenia UTM
Treść UTMutm_contentStringDla śledzenia UTM
Domena niestandardowadomainStringWymagane, jeśli podano slug. Zobacz domeny niestandardowe
Sufiks domeny niestandardowejslugStringJeśli domena jest podana i slug ma wartość null, będzie automatycznie generowany
Tytuł Open Graphog_titleStringDla podglądów mediów społecznych
Opis Open Graphog_descriptionStringDla podglądów mediów społecznych
URL obrazu Open Graphog_imageStringDla podglądów mediów społecznych
ID piksela Metafb_pixel_idStringDla piksela Meta
ID Google Analytics 4ga4_tag_idString
Kontener Google Tag Managergtm_idString
Data i godzina wygaśnięciaexpiry_datetimeCiąg ISO8601 DateTimeDla linków wygasających
Cel wygaśnięciaexpiry_destinationStringDla linków wygasających
Style kodów QRqr_stylesObiekt JSONDla stylizacji kodów QR. Klucze: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
RegułyrulesTablica JSONDla rotatorów, przekierowań geo i przekierowań urządzeń

Przykładowe żądanie przy użyciu cURL

Poniższy kod ilustruje, jak wykonać żądanie API do 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 identyfikatorem linku.

{
    "id": 9512,
    "alias": null,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "head_tags": null,
    "body_tags": null,
    "linkify_words": null,
    "enabled": true,
    "cloaking": false,
    "replacements": 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,
    "full_url": "https://l.linklyhq.com/l/2TQ",
    "block_bots": false,
    "rules": [],
    "workspace_id": 1448,
    "referer_mode": null,
    "custom_referer": null,
    "click_fraud_mode": null,
    "deleted": false
}

Aktualizowanie 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ć, oraz zmiany.

Tworzenie rotatorów za pośrednictwem API

Aby utworzyć rotator, prześlij pole o nazwie rules jako tablica JSON, wraz z powyższą ł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ń geograficznych za pośrednictwem API

Aby przekierować według kraju, prześlij pole o nazwie rules jako tablica JSON, wraz z powyższą ł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ższą ł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 jest jednym 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 opaść żądania linków w tablicę w 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 przetwarzanie dużego żądania może potrwać do 60 sekund. Jeśli żądania trwają dłużej, nie powiedzie się, a Ty powinieneś rozdzielić obciążenie pracą na mniejsze części.

Limity szybkości

API skracania linków jest ograniczone do 20 żądań/sekundę. Do 200 żądań na sekundę dostępnych na żądanie. Możesz przesłać do 1000 linków w jednym żądaniu.

Powiązane

Dostępność planu

Dostępne od planu Pro

Porównaj plany →

Śledź 500 kliknięć miesięcznie za darmo.