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 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 della tua applicazione. Non è necessario spendere tempo per un'integrazione complessa. La nostra API è completamente machine-consumable.
Specifica OpenAPI 3.0
Puoi generare richieste API direttamente dall'interfaccia utente di Linkly.
Generatore di 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 il codice per la tua applicazione.
L'API di Linkly è documentata utilizzando lo standard OpenAPI, che va oltre ciò che viene fornito di seguito. Gli stessi endpoint sono disponibili anche come raccolta Postman con un solo clic.
Autorizzazione
Avrai bisogno di:
- La tua chiave API
- ID 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 utilizzare application/json.
Ti consigliamo di utilizzare JSON con la specifica 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 si aggiorna un link esistente |
| Destinazione | url | String | Obbligatorio |
| Soprannome | name | String | |
| Note | note | String | |
| Tag di retargeting (area head) | head_tags | String | Per pixel di retargeting |
| Tag di retargeting (area body) | body_tags | String | Per pixel di retargeting |
| Inoltro parametri | forward_params | Boolean | |
| Nascondi referrer | hide_referrer | Boolean | Invia referrer-policy: no-referrer in modo che la destinazione non veda Linkly nell'intestazione referer |
| Cloaking | cloaking | Boolean | Maschera l'URL di destinazione dietro un frame |
| Blocca bot | block_bots | Boolean | Blocca bot/crawler noti |
| Salta tracciamento crawler social | skip_social_crawler_tracking | Boolean | Quando block_bots è attivo, lascia comunque passare i social crawler in modo che le anteprime 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 di pubblicazione | enabled | Boolean | |
| Sorgente UTM | utm_source | String | Per tracciamento UTM |
| Mezzo UTM | utm_medium | String | Per tracciamento UTM |
| Campagna UTM | utm_campaign | String | Per tracciamento UTM |
| Termine UTM | utm_term | String | Per tracciamento UTM |
| Contenuto UTM | utm_content | String | Per tracciamento UTM |
| Dominio personalizzato | domain | String | Obbligatorio se lo slug è fornito. Vedi domini personalizzati |
| Suffisso dominio personalizzato | slug | String | Se il dominio è fornito e lo slug è null, sarà auto-generato |
| Titolo Open Graph | og_title | String | Per anteprime media social |
| Descrizione Open Graph | og_description | String | Per anteprime media social |
| URL immagine Open Graph | og_image | String | Per anteprime media social |
| 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 parole | linkify_words | String | Frasi separate da nuove righe che devono essere automaticamente abbreviate sulle pagine di destinazione |
| Sostituzioni | replacements | String | Regole di sostituzione del testo applicate alla pagina di destinazione |
| Data e ora scadenza | expiry_datetime | ISO8601 DateTime String | Per link in scadenza |
| Destinazione scadenza | expiry_destination | String (URL) | Per link in scadenza. Deve iniziare con http. |
| Click scadenza | expiry_clicks | Integer | Scadi il link dopo questo numero di clic |
| Webhook | 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 clic |
| Stili codice QR | qr_styles | JSON object | Per stile codice QR. Chiavi: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| Regole | rules | JSON array | Per rotatori, geo-reindirizzamenti, e reindirizzamenti dispositivi |
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 riuscita restituirà un oggetto JSON che rappresenta il link, insieme a un id link.
{
"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 vuoi aggiornare, insieme alle modifiche.
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.
Per esempio:
[
{"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
{"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]
Creazione di geo-reindirizzamenti tramite API
Per reindirizzare 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.
Per 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 dispositivi tramite API
Per reindirizzare per dispositivo, invia un campo chiamato rules come array JSON, insieme al payload del link sopra.
Per esempio:
[
{"what": "platform", "url": "https://www.google.com", "matches": "windows"},
{"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]
Dove il campo matches è uno dei seguenti:
- 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, utilizza 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ò richiedere fino a 60 secondi per una richiesta di grandi dimensioni. Se le richieste richiedono più tempo, falliranno e dovresti considerare di suddividere 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 report 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.