Dokumentasi API
Buat, kelola, dan tarik statistik tautan secara terprogram lewat REST API Quik.mn.
Semua layanan
Semua produk platform Quik.mn — lewat REST API maupun web.
Alamat dasar
Semua endpoint diawali alamat dasar berikut:
Autentikasi
Pada setiap permintaan, sertakan kunci API dari dasbor Anda Authorization di header berikut:
Jangan bagikan kunci Anda kepada siapa pun. Jika bocor, buat ulang dari dasbor.
Daftar endpoint
Parameter
POST /api/v1/links — kolom body:
GET /api/v1/links — parameter query:
Format kesalahan
Setiap kesalahan dikembalikan dengan kode status HTTP (401, 404, 409, 422, 429) dan struktur JSON yang seragam:
{ "error": "alias_taken", "message": "Alias ini dicadangkan atau sudah digunakan." }
Kode yang umum: unauthorized (401), not_found (404), alias_taken (409), invalid_url / invalid_alias / invalid_expires_at / invalid_starts_at (422), rate_limited (429).
Batasan
Contoh permintaan
Contoh cURL membuat tautan pendek:
curl -X POST https://quik.mn/api/v1/links \
-H "Authorization: Bearer qk_live_xxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/jalur/yang/sangat/panjang",
"alias": "promo",
"title": "Kampanye Ramadan",
"expires_at": "2026-12-31 23:59:59"
}'
Webhook
Daftarkan endpoint di bagian Webhook pada dasbor — begitu peristiwa yang dipilih terjadi, kami mengirim POST JSON ke URL Anda. Respons 2xx = berhasil; jika tidak, kami mencoba ulang hingga 3 kali dengan jeda 1 → 10 menit. Setelah 10 kegagalan berturut-turut, webhook dinonaktifkan otomatis.
Struktur setiap pengiriman (contoh):
{
"event": "link.created",
"created_at": "2026-07-18T09:30:00+00:00",
"data": {
"link": {
"id": 42, "slug": "promo", "short_url": "https://quik.mn/promo",
"long_url": "https://example.com/jalur/yang/sangat/panjang", "title": "Kampanye Ramadan",
"clicks": 0, "active": true, "state": "ok",
"created_at": "2026-07-18 09:30:00", "expires_at": "2027-07-18 09:30:00"
}
}
}
Verifikasi tanda tangan
Setiap pengiriman disertai header berikut: X-Quik-Event (nama peristiwa), X-Quik-Signature — sha256=HMAC_SHA256(body, secret). Secret hanya ditampilkan sekali, saat webhook dibuat. Tanda tangan WAJIB diverifikasi pada body mentah (raw) dengan perbandingan waktu-konstan:
<?php
// PHP — verifikasi tanda tangan pada body mentah (raw)
$payload = file_get_contents('php://input');
$signature = $_SERVER['HTTP_X_QUIK_SIGNATURE'] ?? '';
$expected = 'sha256=' . hash_hmac('sha256', $payload, $secret);
if (!hash_equals($expected, $signature)) {
http_response_code(401);
exit('invalid signature');
}
$event = json_decode($payload, true);
// $event['event'], $event['data'] ...
http_response_code(200);
// Node.js (Express) — verifikasi tanda tangan pada body mentah (raw)
const crypto = require('crypto');
app.post('/quik-webhook', express.raw({ type: 'application/json' }), (req, res) => {
const signature = req.get('X-Quik-Signature') || '';
const expected = 'sha256=' +
crypto.createHmac('sha256', secret).update(req.body).digest('hex');
const a = Buffer.from(expected), b = Buffer.from(signature);
if (a.length !== b.length || !crypto.timingSafeEqual(a, b)) {
return res.status(401).send('invalid signature');
}
const event = JSON.parse(req.body); // event.event, event.data ...
res.sendStatus(200);
});
Batas: paket Free 1, Pro 3, Business 10 webhook. Endpoint harus alamat http/https yang dapat diakses publik (alamat jaringan internal dilarang).
