API di accorciamento dei link di Linkly

Crea, aggiorna e gestisci i link a livello di programmazione utilizzando l'API di accorciamento dei link di Linkly.

Correlati: API Analytics | Webhook

Prima di iniziare

Linkly genera le richieste API nell'interfaccia che puoi copiare e incollare nelle tue applicazioni.

Questo funziona per la creazione di link e l'aggiornamento di link.

Risparmia tempo e lascia che facciamo il lavoro pesante:

  1. 1
    Vedi di seguito per le richieste API di creazione dei link.
  2. 2
    Copia le richieste nella loro interezza. Puoi verificare che funzionino per te.
  3. 3
    Chiedi a ChatGPT o equivalente di adattare queste richieste al codice sorgente per la tua applicazione. Non è necessario dedicare tempo a un'integrazione complessa. La nostra API è completamente leggibile da macchina.

Specifica OpenAPI 3.0

Puoi generare le richieste API direttamente dall'interfaccia utente di Linkly.

Generatore API di accorciamento dei link di Linkly

L'API di accorciamento dei link di Linkly genera automaticamente le richieste API in base al contenuto del modulo. Puoi incollare il testo fornito qui in qualsiasi LLM per generare automaticamente codice per la tua applicazione.

L'API di Linkly è documentata utilizzando lo standard OpenAPI, che va oltre quanto fornito di seguito. Gli stessi endpoint sono disponibili anche come una raccolta Postman con un clic.

Visualizza specifica OpenAPI

Esegui in Postman

Autorizzazione

Ti serviranno:

  • La tua chiave API
  • ID dell'area di lavoro

Puoi ottenere questi dettagli da Linkly.

  1. 1
    Accedi a Linkly.
  2. 2
    Fai clic su Impostazioni.
  3. 3
    Fai clic su Chiavi API.

Per creare un link, tutto ciò che devi fare è inviare una richiesta POST a:

https://app.linklyhq.com/api/v1/link

con i seguenti campi nel corpo.

Il tipo di codifica è x-www-form-urlencoded o application/json.

Se stai inviando il campo Rules, devi utilizzare application/json.

Ti consigliamo di utilizzare JSON con la specifica Open API.

EtichettaChiaveTipoNote
Chiave API dell'accountapi_keyStringObbligatorio
ID dell'area di lavoroworkspace_idIntegerObbligatorio
ID del linkidIntegerObbligatorio se si aggiorna un link esistente
DestinazioneurlStringObbligatorio
SoprannomenameString
NotenoteString
MetadatimetadataObjectI tuoi dati chiave-valore, come gli ID dal tuo sistema. Vedi metadati
Tag di retargeting (area head)head_tagsStringPer pixel di retargeting
Tag di retargeting (area body)body_tagsStringPer pixel di retargeting
Forward Paramsforward_paramsBoolean
Nascondi referrerhide_referrerBooleanInvia referrer-policy: no-referrer così la destinazione non vede Linkly nell'intestazione del referrer
MascheramentocloakingBooleanMaschera l'URL di destinazione dietro un frame
Blocca botblock_botsBooleanBlocca bot/crawler noti
Salta tracciamento crawler socialskip_social_crawler_trackingBooleanQuando block_bots è attivo, lascia comunque passare i crawler social per far funzionare le anteprime OG
Analitiche pubblichepublic_analyticsBooleanAbilita la pagina pubblica /abc123.stats per questo link
PasswordpasswordStringI visitatori devono inserire questa password prima del reindirizzamento
Stato di pubblicazioneenabledBoolean
UTM Sourceutm_sourceStringPer il tracciamento UTM
UTM Mediumutm_mediumStringPer il tracciamento UTM
UTM Campaignutm_campaignStringPer il tracciamento UTM
UTM Termutm_termStringPer il tracciamento UTM
UTM Contentutm_contentStringPer il tracciamento UTM
Dominio personalizzatodomainStringObbligatorio se viene fornito uno slug. Vedi domini personalizzati
Suffisso dominio personalizzatoslugStringSe domain viene fornito e slug è null, verrà generato automaticamente
Titolo Open Graphog_titleStringPer le anteprime social media
Descrizione Open Graphog_descriptionStringPer le anteprime social media
URL immagine Open Graphog_imageStringPer le anteprime social media
ID Meta Pixelfb_pixel_idStringPer Meta Pixel
ID TikTok Pixeltiktok_pixel_idString
ID Google Analytics 4ga4_tag_idString
Contenitore Google Tag Managergtm_idString
Linkify Wordslinkify_wordsStringFrasi separate da newline che dovrebbero essere abbreviate automaticamente nelle landing page
SostituzionireplacementsStringRegole di sostituzione del testo applicate alla pagina di destinazione
Data/ora di scadenzaexpiry_datetimeStringa ISO8601 DateTimePer i link in scadenza
Destinazione di scadenzaexpiry_destinationString (URL)Per i link in scadenza. Deve iniziare con http.
Click di scadenzaexpiry_clicksIntegerScadenza del link dopo questo numero di click
WebhookwebhooksArray di stringheURL webhook per singolo link. Vedi webhook.
Notifica ID utentinotify_user_idsArray di interiID utenti dell'area di lavoro da notificare ad ogni click
Stili codice QRqr_stylesOggetto JSONPer lo styling del codice QR. Chiavi: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
RegolerulesArray JSONPer rotatori, reindirizzamenti geografici, e reindirizzamenti per dispositivo

Esempio di richiesta utilizzando curl

Il codice seguente illustra come effettuare una richiesta API per creare un link.

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'

Una risposta corretta restituirà un oggetto JSON che rappresenta il link, insieme a un id del link.

{
    "id": 9512,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "metadata": {},
    "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
}

Per aggiornare un link, invia la stessa richiesta che useresti per creare il link, ma includi il campo id per il link che desideri aggiornare, insieme alle modifiche.

Utilizza metadati per memorizzare i tuoi identificatori rispetto a un link, come un ID ordine, un ID contatto CRM o un riferimento di campagna dal tuo sistema. È un insieme di coppie chiave-valore e ritorna ogni volta che recuperi il link e in ogni payload webhook (eventi clic e link), così puoi associare un clic al record a cui appartiene.

Invialo in un corpo di richiesta JSON, come oggetto:

curl -X POST https://app.linklyhq.com/api/v1/link
-H 'Content-Type: application/json'
-d '{"api_key": "your_secret_key", "workspace_id": 1, "url": "https://example.com", "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}}'

Il link nella risposta include "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}.

Come funziona:

  • Gli aggiornamenti vengono uniti. Quando aggiorni un link, le chiavi che invii vengono aggiunte ai metadati esistenti del link e le chiavi che non menzioni vengono lasciate sole. Per rimuovere una chiave, impostala su null (ad esempio {"metadata": {"order_id": null}}).
  • I valori sono stringhe. I numeri e i booleani vengono memorizzati come testo, quindi 42 torna come "42". Gli oggetti e gli array annidati non sono consentiti.
  • Limiti. Fino a 20 chiavi per link, chiavi fino a 40 caratteri e valori fino a 500 caratteri, sufficienti per un UUID.
  • Privato per te. I metadati non vengono mai mostrati alle persone che fanno clic sul link, non vengono utilizzati per creare il reindirizzamento e non vengono aggiunti all'URL di destinazione.
  • Nell'app. Puoi anche visualizzare e modificare i metadati nelle impostazioni di Automazione di un link, in Metadati.

Metadati, note e parametri UTM

I metadati, il campo note e i parametri UTM descrivono tutti un link, ma svolgono compiti diversi:

  • Metadati sono dati strutturati chiave-valore per i tuoi sistemi. Vengono restituiti dall'API e inviati nei webhook, quindi il software può leggerli.
  • Note è un singolo campo di testo libero per una persona da leggere nell'app.
  • Parametri UTM vengono aggiunti all'URL di destinazione, quindi la pagina a cui invii i visitatori e la sua analitiche possono vederli. I metadati mai. Per passare un valore alla pagina di destinazione, usa un parametro UTM, oppure attiva Inoltro parametri così i parametri di query sul link breve vengono passati.

Metadati e analitiche

I metadati non sono inclusi nelle analitiche dei clic o nelle esportazioni di clic, e non puoi raggruppare o filtrare i clic, o cercare i link, in base ai metadati. Per collegare i clic ai tuoi record, utilizza l'id del link. Appare nei payload dei webhook, nell'analitiche suddivisi per link e nelle risposte dei link. Cerca il tuo record dall'id del link dal tuo lato, o recupera il link per leggerne i metadati.

Creazione di rotatori tramite API

Per creare un rotatore, invia un campo chiamato rules come array JSON, insieme al payload del link sopra. Devi utilizzare application/json per inviare array JSON.

Ad esempio:

[
  {"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
  {"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]

Creazione di reindirizzamenti geografici tramite API

Per effettuare il reindirizzamento per paese, invia un campo chiamato rules come array JSON, insieme al payload del link sopra. Devi utilizzare la codifica application/json per inviare array JSON.

Ad esempio:

[
  {"what": "country", "url": "https://www.microsoft.com", "matches": "UK"},
  {"what": "country", "url": "https://www.apple.com", "matches": "US"}
]

Il paese è il codice paese ISO 3166 alpha-2.

Creazione di reindirizzamenti per dispositivo tramite API

Per effettuare il reindirizzamento per dispositivo, invia un campo chiamato rules come array JSON, insieme al payload del link sopra.

Ad esempio:

[
  {"what": "platform", "url": "https://www.google.com", "matches": "windows"},
  {"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]

Dove il campo matches è uno di:

  • ios
  • android
  • windows
  • linux
  • mac

Linkly supporta la creazione/modifica di fino a 1000 link per richiesta.

Per farlo, invia la tua chiave API come parte della richiesta come segue:

https://app.linklyhq.com/api/v1/links?api_key=XXXXXXXXXXX

Quindi, utilizza lo stesso schema di cui sopra per i casi di link individuali, ma avvolgi le richieste di link in un array, della forma:

[{link}, {link}]

Ecco una richiesta completa che aggiornerà due link:

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'

Questo funziona sia per le azioni di creazione che di aggiornamento.

Tieni presente che può richiedere fino a 60 secondi per una richiesta di grandi dimensioni. Se le richieste richiedono più tempo di questo, non riusciranno e dovresti considerare di suddividere il tuo carico di lavoro in blocchi più piccoli.

Limiti di velocità

L'API di accorciamento dei link è limitata a 20 richieste/secondo. Fino a 200 richieste al secondo sono disponibili su richiesta. Puoi caricare fino a 1000 link in una singola richiesta.

Correlati

Disponibilità del piano

Incluso in tutti i piani

Confronta i piani →

Traccia 500 clic mensili gratuitamente.