REST API

Pasang Cliqly di dalam sistem Anda sendiri

API Cliqly membuat, mengubah, dan menghapus link; mengelola domain; dan mengembalikan statistik klik — semuanya lewat HTTP dan JSON. Akses API termasuk dalam setiap paket berlangganan, sehingga Anda bisa menjalankan link pendek dari CRM, panel internal, alur otomasi, atau produk Anda sendiri tanpa membuka dashboard.

Daftar dan ambil API key Lihat paket berlangganan

Kemampuan

Apa yang bisa dilakukan lewat API

Link dan domain

Buat link satuan atau massal, ubah tujuannya, atur slug, folder, tag, masa berlaku, dan aturan targeting. Daftarkan domain, periksa status DNS-nya, dan klaim subdomain gratis.

Statistik

Tarik deret waktu per jam, hari, minggu, atau bulan, serta breakdown per negara, kota, perangkat, OS, browser, referrer, dan parameter UTM — untuk satu link, satu domain, atau seluruh organisasi.

Webhook

Terima notifikasi link.created, domain.verified, quota.threshold, quota.exceeded, dan abuse.flagged ke endpoint Anda, dengan tanda tangan yang bisa diverifikasi.

Contoh

`POST /links` — membuat satu link

Kirim API key pada header Authorization, tanpa awalan Bearer. Field originalURL wajib dan harus URL absolut; path boleh dikosongkan agar slug dibuat acak.

Request

curl -X POST https://cliqly.dev/api/v1/links \
  -H "Authorization: sk_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "go.tokoanda.co.id",
    "originalURL": "https://tokoanda.co.id/promo-agustus",
    "path": "promo",
    "title": "Promo Agustus",
    "tags": ["agustus", "instagram"]
  }'

Response

201 Created

{
  "originalURL": "https://tokoanda.co.id/promo-agustus",
  "path": "promo",
  "idString": "lnk_7Kp2mQx9Ab",
  "shortURL": "https://go.tokoanda.co.id/promo",
  "secureShortURL": "https://go.tokoanda.co.id/promo",
  "createdAt": "2026-08-17T09:12:44.317Z",
  "DomainId": "dom_4f21",
  "OwnerId": "org_9c07",
  "success": true,
  "duplicate": false
}

Daftar link — GET /links

curl "https://cliqly.dev/api/v1/links?limit=30&q=promo" \
  -H "Authorization: sk_live_xxxxxxxxxxxxxxxxxxxx"

{
  "links": [ /* … */ ],
  "count": 128,
  "nextPageToken": "eyJvIjoxMzB9"
}

Galat — slug sudah dipakai

409 Conflict

{
  "error": "Slug /promo sudah dipakai di go.tokoanda.co.id. Pilih slug lain atau kosongkan untuk slug acak.",
  "field": "path"
}

Setiap galat menyebutkan apa yang salah dan bagaimana memperbaikinya, dan menyertakan field yang bermasalah bila galatnya soal input. Kode yang sering muncul: 400 input tidak valid, 401 API key salah atau dicabut, 402 kuota paket habis, 403 organisasi ditangguhkan, 404 domain tidak terdaftar, 409 slug bentrok atau domain belum terverifikasi.

Migrasi biasanya cuma ganti base URL

Bentuk request dan response mengikuti konvensi shortener umum

Nama field, kapitalisasi yang tidak konsisten, dan header Authorization tanpa Bearer semuanya dipertahankan apa adanya demi kompatibilitas. Untuk pembuatan dan pembacaan link, SDK atau langkah otomasi yang sudah Anda punya umumnya cukup diarahkan ulang ke https://cliqly.dev/api/v1 dengan API key Cliqly.

Kami menyebutnya kompatibel secara bentuk, bukan identik. Selalu jalankan integrasi Anda di lingkungan uji lebih dulu.

Tanya soal migrasi

Autentikasi dan scope

Satu key, satu kewenangan

links:read — membaca daftar dan detail link
links:write — membuat, mengubah, menghapus link
domains:read — membaca domain dan status DNS-nya
domains:write — menambah dan mengubah domain
stats:read — membaca statistik klik

Key bisa dicabut kapan saja dari dashboard, dan pencabutan berlaku seketika. Setiap key mencatat kapan terakhir dipakai.

Dokumentasi

Referensi lengkap

Halaman ini adalah ringkasan. Daftar endpoint lengkap, parameter, kode galat, batas laju permintaan, dan format webhook ada di dokumentasi.

Buka dokumentasi API Butuh bantuan integrasi

Siapa yang bisa memakai API?

Semua pelanggan berlangganan. Akses API termasuk dalam paket Hobby, Pro, Team, dan Enterprise — tidak dijual terpisah dan tidak ada biaya tambahan per permintaan. Paket Free tidak menerbitkan API key; kalau Anda perlu API, paket berbayar termurah sudah cukup. Lihat halaman harga.

Bagaimana cara mendapatkan API key?

Dari dashboard, di Settings → API. Setiap key diberi nama dan scope sendiri, dan nilainya hanya ditampilkan sekali saat dibuat. Key dikirim pada header Authorization tanpa awalan Bearer — itu bentuk yang kompatibel dengan shortener lain, dan sengaja dipertahankan.

Seberapa besar perubahan kode kalau saya pindah dari layanan lain?

Untuk pembuatan link, umumnya hanya base URL dan API key. Nama field pada request dan response mengikuti konvensi shortener yang banyak dipakai — termasuk originalURL, idString, shortURL, DomainId, dan OwnerId dengan kapitalisasi apa adanya.

Kami tidak menjanjikan kompatibilitas penuh untuk seluruh permukaan API layanan lain. Endpoint di luar link dan domain punya bentuknya sendiri; periksa dokumentasi sebelum memindahkan integrasi yang rumit.

Apa yang terjadi kalau kuota paket terlampaui?

Permintaan pembuatan link baru dijawab 402 quota_exceeded, sementara link yang sudah ada tetap melayani trafik. Untuk permintaan massal, seluruh batch ditolak — tidak pernah setengah jadi. Kalau organisasi ditangguhkan, endpoint yang mengubah data menjawab 403 org_suspended dan redirect menjawab 410 Gone.