API di accorciamento link di Linkly
Crea, aggiorna e gestisci link a livello di programmazione utilizzando l'API di accorciamento link di Linkly.
Correlato: Analytics API | Webhooks
Prima di iniziare
Linkly genera richieste API nell'interfaccia per te da 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 difficile:
- 1Vedi di seguito per le richieste API di creazione link.
- 2Copia le richieste per intero. Puoi verificare che funzionino per te.
- 3Chiedi 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 dalle macchine.
Specifica OpenAPI 3.0
Puoi generare richieste API direttamente dall'interfaccia utente di Linkly.
Generatore API di accorciamento link di Linkly
L'API di accorciamento link di Linkly crea automaticamente 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 ciò che è fornito di seguito. Gli stessi endpoint sono disponibili anche come una collezione Postman con un clic.
Autorizzazione
Avrai bisogno di:
- La tua chiave API
- ID dell'area di lavoro
Puoi ottenere questi dettagli da dentro Linkly.
- 1Accedi a Linkly.
- 2Fai clic su Impostazioni.
- 3Fai clic su Chiavi API.
Creazione o aggiornamento di un link
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 usare application/json.
Ti consigliamo di utilizzare JSON con le specifiche Open API.
| Etichetta | Chiave | Tipo | Note |
|---|---|---|---|
| Chiave API Account | api_key | String | Obbligatorio |
| ID Area di lavoro | workspace_id | Integer | Obbligatorio |
| ID Link | id | Integer | Obbligatorio se aggiorna un link esistente |
| Destinazione | url | String | Obbligatorio |
| Soprannome | name | String | |
| Note | note | String | |
| Tag retargeting (regione head) | head_tags | String | Per pixel di retargeting |
| Tag retargeting (regione body) | body_tags | String | Per pixel di retargeting |
| Forward Params | forward_params | Boolean | |
| Nascondi Referrer | hide_referrer | Boolean | Invia referrer-policy: no-referrer quindi la destinazione non vede Linkly nell'intestazione referrer |
| Cloaking | cloaking | Boolean | Nasconde l'URL di destinazione dietro un frame |
| Blocca Bot | block_bots | Boolean | Blocca bot/crawler noti |
| Salta Social Crawler Tracking | skip_social_crawler_tracking | Boolean | Quando block_bots è attivo, consenti comunque ai social crawler di passare in modo che i preview OG funzionino |
| Analitiche Pubbliche | public_analytics | Boolean | Abilita la pagina pubblica /abc123.stats per questo link |
| Password | password | String | I visitatori devono inserire questa password prima del reindirizzamento |
| Stato Pubblicazione | enabled | Boolean | |
| UTM Source | utm_source | String | Per tracking UTM |
| UTM Medium | utm_medium | String | Per tracking UTM |
| UTM Campaign | utm_campaign | String | Per tracking UTM |
| UTM Term | utm_term | String | Per tracking UTM |
| UTM Content | utm_content | String | Per tracking UTM |
| Dominio Personalizzato | domain | String | Obbligatorio se slug è fornito. Vedi domini personalizzati |
| Suffisso Dominio Personalizzato | slug | String | Se dominio è fornito e slug è null, sarà generato automaticamente |
| Titolo Open Graph | og_title | String | Per anteprime media sociale |
| Descrizione Open Graph | og_description | String | Per anteprime media sociale |
| URL Immagine Open Graph | og_image | String | Per anteprime media sociale |
| ID Meta Pixel | fb_pixel_id | String | Per Meta Pixel |
| ID TikTok Pixel | tiktok_pixel_id | String | |
| ID Google Analytics 4 | ga4_tag_id | String | |
| Contenitore Google Tag Manager | gtm_id | String | |
| Linkify Words | linkify_words | String | Frasi separate da nuova riga che dovrebbero essere abbreviate automaticamente sulle pagine di destinazione |
| Sostituzioni | replacements | String | Regole di sostituzione del testo applicate alla pagina di destinazione |
| Data/Ora di Scadenza | expiry_datetime | Stringa ISO8601 DateTime | Per link in scadenza |
| Destinazione Scadenza | expiry_destination | String (URL) | Per link in scadenza. Deve iniziare con http. |
| Click Scadenza | expiry_clicks | Integer | Fai scadere il link dopo questo numero di click |
| Webhooks | webhooks | Array of strings | URL webhook per link. Vedi webhooks. |
| ID Utenti da Notificare | notify_user_ids | Array of integers | ID utenti area di lavoro da notificare ad ogni click |
| Stili Codice QR | qr_styles | JSON object | Per styling codice QR. Chiavi: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| Rules | rules | JSON array | Per rotatori, geo-reindirizzamenti, e reindirizzamenti dispositivo |
Esempio di richiesta usando curl
Il codice di seguito 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 di successo restituirà un oggetto JSON che rappresenta il link, insieme a un link id.
{
"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
}
Aggiornamento di un link
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.
Creazione di rotatori via API
Per creare un rotatore, invia un campo chiamato rules come array JSON, insieme al payload del link sopra. Devi usare 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 geo-reindirizzamenti via API
Per reindirizzare per paese, invia un campo chiamato rules come array JSON, insieme al payload del link sopra. Devi usare 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 alfa-2.
Creazione di reindirizzamenti dispositivo via API
Per reindirizzare 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
Creazione o aggiornamento di più link in una sola richiesta
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/link?api_key=XXXXXXXXXXX
Quindi, usa lo stesso schema di cui sopra per i singoli casi di link, 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/workspace/WORKSPACE_ID/links?api_key=API_KEY'
Questo funziona sia per le azioni di creazione che di aggiornamento.
Tieni presente che può volerci fino a 60 secondi per una richiesta di grandi dimensioni. Se le richieste richiedono più tempo di questo, falliranno e dovresti considerare di dividere il tuo carico di lavoro in blocchi più piccoli.
Limiti di velocità
L'API di accorciamento 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.
Correlato
- Analytics API - Esporta dati di clic e rapporti sul traffico
- Webhooks - Notifiche di clic in tempo reale
- Integrazione Zapier - Integrazioni senza codice
Disponibilità del piano
Incluso in tutti i piani
Traccia 500 clic mensili gratuitamente.