API skracania linków Linkly

Twórz, aktualizuj i zarządzaj linkami programistycznie, korzystając z API skracania linków Linkly.

Powiązane: API analityki | Webhooki

Zanim zaczniesz

Linkly generuje żądania API w interfejsie, które możesz skopiować i wkleić do swoich aplikacji.

Działa to dla tworzenia linków i aktualizacji linków.

Oszczędzaj czas i pozwól nam wykonać ciężką pracę:

  1. 1Zobacz poniżej żądania API do tworzenia linków.
  2. 2Skopiuj żądania w całości. Możesz sprawdzić, czy działają w Twoim przypadku.
  3. 3Poproś ChatGPT lub równoważne narzędzie o dostosowanie tych żądań do kodu źródłowego Twojej aplikacji. Nie ma potrzeby spędzać czasu na skomplikowanej integracji. Nasze API jest w pełni czytelne 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 tworzy żądania API na podstawie zawartości formularza. Możesz wkleić podany tutaj tekst do dowolnego LLM, aby automatycznie wygenerować kod dla swojej aplikacji.

API Linkly jest udokumentowane przy użyciu standardu OpenAPI, który wykracza poza to, co przedstawiono poniżej.

Autoryzacja

Będziesz potrzebować:

  • Swojego klucza API
  • ID przestrzeni roboczej

Możesz uzyskać te dane wewnątrz Linkly.

  1. 1Zaloguj się do Linkly.
  2. 2Kliknij Ustawienia.
  3. 3Kliknij Klucze API.

Tworzenie lub aktualizacja 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 wysyłasz pole Rules, musisz użyć application/json.

Zalecamy używanie JSON ze specyfikacją Open API.

EtykietaKluczTypUwagi
Klucz API kontaapi_keyStringWymagane
ID przestrzeni roboczejworkspace_idIntegerWymagane
ID linkuidIntegerWymagane przy aktualizacji istniejącego linku
Miejsce doceloweurlStringWymagane
PseudonimnameString
NotatkinoteString
Tagi retargetingowe (region head)head_tagsStringDla pikseli retargetingowych
Tagi retargetingowe (region body)body_tagsStringDla pikseli retargetingowych
Przekazywanie parametrówforward_paramsBoolean
Status publikacjienabledBoolean
UTM Sourceutm_sourceStringDla śledzenia UTM
UTM Mediumutm_mediumStringDla śledzenia UTM
UTM Campaignutm_campaignStringDla śledzenia UTM
UTM Termutm_termStringDla śledzenia UTM
UTM Contentutm_contentStringDla śledzenia UTM
Domena niestandardowadomainStringWymagane, jeśli podano slug. Zobacz domeny niestandardowe
Sufiks domeny niestandardowejslugStringJeśli podano domenę, a slug jest null, zostanie wygenerowany automatycznie
Tytuł Open Graphog_titleStringDla podglądów mediów społecznościowych
Opis Open Graphog_descriptionStringDla podglądów mediów społecznościowych
URL obrazu Open Graphog_imageStringDla podglądów mediów społecznościowych
Meta Pixel IDfb_pixel_idStringDla Meta Pixel
Google Analytics 4 IDga4_tag_idString
Kontener Google Tag Managergtm_idString
Data i godzina wygaśnięciaexpiry_datetimeCiąg DateTime ISO8601Dla wygasających linków
Miejsce docelowe po wygaśnięciuexpiry_destinationStringDla wygasających linków
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 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 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
}

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

Tworzenie rotatorów za pomocą API

Aby utworzyć rotator, prześlij pole o nazwie rules jako tablicę JSON, wraz z ładunkiem linku powyżej. 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 przekierowań geograficznych za pomocą API

Aby przekierować według kraju, prześlij pole o nazwie rules jako tablicę JSON, wraz z ładunkiem linku powyżej. 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"}
]

Krajem jest dwuliterowy kod kraju ISO 3166 alpha-2.

Tworzenie przekierowań urządzeń za pomocą API

Aby przekierować według urządzenia, prześlij pole o nazwie 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 to jedno z:

  • ios
  • android
  • windows
  • linux
  • mac

Tworzenie lub aktualizacja 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/link?api_key=XXXXXXXXXXX

Następnie użyj tego samego schematu, co powyżej dla pojedynczych 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/workspace/WORKSPACE_ID/links?api_key=API_KEY'

Działa to zarówno dla akcji tworzenia, jak i aktualizacji.

Należy pamiętać, że przetworzenie dużego żądania może zająć do 60 sekund. Jeśli żądania trwają dłużej niż to, zakończą się niepowodzeniem i powinieneś rozważyć podzielenie obciążenia na mniejsze części.

Limity częstotliwości

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

Powiązane

Śledź 500 miesięcznych kliknięć ze wszystkimi funkcjami.

Nie potrzebujesz karty kredytowej