API Pemendekan Tautan Linkly
Buat, perbarui, dan kelola tautan secara programatik menggunakan API Pemendekan Tautan Linkly.
Terkait: Analytics API | Webhooks
Sebelum Anda mulai
Linkly menghasilkan permintaan API di antarmuka untuk Anda salin & tempel ke dalam aplikasi Anda.
Ini berfungsi untuk pembuatan tautan dan pembaruan tautan.
Hemat waktu dan biarkan kami melakukan pekerjaan berat:
- 1Lihat di bawah untuk permintaan API pembuatan tautan.
- 2Salin permintaan secara keseluruhan. Anda dapat memverifikasi bahwa mereka berfungsi untuk Anda.
- 3Minta ChatGPT atau yang setara untuk menyesuaikan permintaan ini menjadi kode sumber untuk aplikasi Anda. Tidak perlu menghabiskan waktu untuk integrasi yang kompleks. API kami sepenuhnya dapat dikonsumsi mesin.
Spesifikasi OpenAPI 3.0
Anda dapat menghasilkan permintaan API langsung dari antarmuka pengguna Linkly.
Pembuat API Pemendekan Tautan Linkly
API pemendekan tautan Linkly membangun permintaan API secara otomatis berdasarkan isi formulir. Anda dapat menempel teks yang diberikan di sini ke dalam LLM apa pun untuk secara otomatis menghasilkan kode untuk aplikasi Anda.
API Linkly didokumentasikan menggunakan standar OpenAPI, yang melampaui apa yang disediakan di bawah. Endpoint yang sama juga tersedia sebagai koleksi Postman satu klik.
Otorisasi
Anda akan memerlukan:
- Kunci API Anda
- ID Ruang Kerja
Anda dapat mendapatkan detail ini dari dalam Linkly.
- 1Login ke Linkly.
- 2Klik Pengaturan.
- 3Klik Kunci API.
Membuat atau memperbarui tautan
Untuk membuat tautan, yang perlu Anda lakukan adalah mengirim permintaan POST ke:
https://app.linklyhq.com/api/v1/link
dengan bidang berikut di badan permintaan.
Jenis pengkodean adalah x-www-form-urlencoded atau application/json.
Jika Anda mengirimkan bidang Rules, Anda harus menggunakan application/json.
Kami merekomendasikan Anda menggunakan JSON dengan spesifikasi Open API.
| Label | Kunci | Jenis | Catatan |
|---|---|---|---|
| Kunci API Akun | api_key | String | Diperlukan |
| ID Ruang Kerja | workspace_id | Integer | Diperlukan |
| ID Tautan | id | Integer | Diperlukan jika memperbarui tautan yang ada |
| Tujuan | url | String | Diperlukan |
| Julukan | name | String | |
| Catatan | note | String | |
| Tag retargeting (wilayah head) | head_tags | String | Untuk piksel retargeting |
| Tag retargeting (wilayah body) | body_tags | String | Untuk piksel retargeting |
| Parameter Forward | forward_params | Boolean | |
| Sembunyikan Referrer | hide_referrer | Boolean | Mengirim referrer-policy: no-referrer sehingga tujuan tidak melihat Linkly di header referer |
| Cloaking | cloaking | Boolean | Menyembunyikan URL tujuan di balik frame |
| Blokir Bot | block_bots | Boolean | Memblokir bot/crawler yang diketahui |
| Lewati Pelacakan Crawler Media Sosial | skip_social_crawler_tracking | Boolean | Ketika block_bots aktif, tetap biarkan crawler media sosial melalui sehingga pratinjau OG berfungsi |
| Analytics Publik | public_analytics | Boolean | Mengaktifkan halaman publik /abc123.stats untuk tautan ini |
| Kata Sandi | password | String | Pengunjung harus memasukkan kata sandi ini sebelum pengalihan |
| Status Penerbitan | enabled | Boolean | |
| Sumber UTM | utm_source | String | Untuk pelacakan UTM |
| Medium UTM | utm_medium | String | Untuk pelacakan UTM |
| Kampanye UTM | utm_campaign | String | Untuk pelacakan UTM |
| Istilah UTM | utm_term | String | Untuk pelacakan UTM |
| Konten UTM | utm_content | String | Untuk pelacakan UTM |
| Domain Khusus | domain | String | Diperlukan jika slug disediakan. Lihat domain khusus |
| Akhiran Domain Khusus | slug | String | Jika domain disediakan dan slug null, akan dibuat secara otomatis |
| Judul Open Graph | og_title | String | Untuk pratinjau media sosial |
| Deskripsi Open Graph | og_description | String | Untuk pratinjau media sosial |
| URL Gambar Open Graph | og_image | String | Untuk pratinjau media sosial |
| ID Meta Pixel | fb_pixel_id | String | Untuk Meta Pixel |
| ID Piksel TikTok | tiktok_pixel_id | String | |
| ID Google Analytics 4 | ga4_tag_id | String | |
| Kontainer Google Tag Manager | gtm_id | String | |
| Linkify Kata | linkify_words | String | Frasa yang dipisahkan baris baru yang harus diperpendek secara otomatis di halaman landing |
| Penggantian | replacements | String | Aturan penggantian teks yang diterapkan ke halaman tujuan |
| Waktu Tanggal Kedaluwarsa | expiry_datetime | String Waktu Tanggal ISO8601 | Untuk tautan yang kedaluwarsa |
| Tujuan Kedaluwarsa | expiry_destination | String (URL) | Untuk tautan yang kedaluwarsa. Harus dimulai dengan http. |
| Klik Kedaluwarsa | expiry_clicks | Integer | Kedaluwarsa tautan setelah klik sebanyak ini |
| Webhooks | webhooks | Array string | URL webhook per tautan. Lihat webhooks. |
| Beri Tahu ID Pengguna | notify_user_ids | Array integer | ID pengguna ruang kerja yang akan diberitahu pada setiap klik |
| Gaya Kode QR | qr_styles | Objek JSON | Untuk gaya kode QR. Kunci: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| Aturan | rules | Array JSON | Untuk rotator, pengalihan geo, dan pengalihan perangkat |
Contoh permintaan menggunakan curl
Kode di bawah mengilustrasikan cara membuat permintaan API untuk membuat tautan.
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'
Respons yang berhasil akan mengembalikan objek JSON yang mewakili tautan, bersama dengan id tautan.
{
"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
}
Memperbarui tautan
Untuk memperbarui tautan, kirim permintaan yang sama yang Anda gunakan untuk membuat tautan, tetapi sertakan bidang id untuk tautan yang ingin Anda perbarui, serta perubahannya.
Membuat rotator melalui API
Untuk membuat rotator, kirimkan bidang yang disebut rules sebagai array JSON, bersama dengan payload tautan di atas. Anda harus menggunakan application/json untuk mengirim array JSON.
Misalnya:
[
{"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
{"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]
Membuat pengalihan geo melalui API
Untuk mengalihkan berdasarkan negara, kirimkan bidang yang disebut rules sebagai array JSON, bersama dengan payload tautan di atas. Anda harus menggunakan pengkodean application/json untuk mengirim array JSON.
Misalnya:
[
{"what": "country", "url": "https://www.microsoft.com", "matches": "UK"},
{"what": "country", "url": "https://www.apple.com", "matches": "US"}
]
Negara adalah kode negara ISO 3166 alfa-2.
Membuat pengalihan perangkat melalui API
Untuk mengalihkan berdasarkan perangkat, kirimkan bidang yang disebut rules sebagai array JSON, bersama dengan payload tautan di atas.
Misalnya:
[
{"what": "platform", "url": "https://www.google.com", "matches": "windows"},
{"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]
Di mana bidang matches adalah salah satu dari:
- ios
- android
- windows
- linux
- mac
Membuat atau memperbarui beberapa tautan dalam satu permintaan
Linkly mendukung pembuatan/perubahan hingga 1000 tautan per permintaan.
Untuk melakukannya, kirimkan kunci API Anda sebagai bagian dari permintaan sebagai berikut:
https://app.linklyhq.com/api/v1/links?api_key=XXXXXXXXXXX
Kemudian, gunakan skema yang sama dengan kasus tautan individual di atas, tetapi bungkus permintaan tautan dalam array, dengan bentuk:
[{link}, {link}]
Berikut adalah permintaan lengkap yang akan memperbarui dua tautan:
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'
Ini berfungsi untuk tindakan pembuatan dan pembaruan.
Harap dicatat bahwa dapat memakan waktu hingga 60 detik untuk permintaan besar. Jika permintaan memakan waktu lebih lama dari ini, permintaan akan gagal, dan Anda harus mempertimbangkan untuk membagi beban kerja Anda menjadi potongan yang lebih kecil.
Batas Laju
API pemendekan tautan dibatasi hingga 20 permintaan/detik. Hingga 200 permintaan per detik tersedia atas permintaan. Anda dapat mengunggah hingga 1000 tautan dalam satu permintaan.
Terkait
- Analytics API - Ekspor data klik dan laporan lalu lintas
- Webhooks - Notifikasi klik real-time
- Integrasi Zapier - Integrasi tanpa kode
Ketersediaan paket
Termasuk dalam setiap paket
Dapatkan 100 tautan pendek dan lacak 500 klik bulanan secara gratis.