Документация API
Создавайте ссылки, управляйте ими и выгружайте статистику программно — через REST API Quik.mn.
Все сервисы
Все продукты платформы Quik.mn — через REST API и в веб-интерфейсе.
Базовый адрес
Все endpoint начинаются с базового адреса:
Авторизация
В каждом запросе передавайте API-ключ из панели управления в заголовке Authorization — вот так:
Никому не передавайте свой ключ. Если он попал в чужие руки, создайте новый в панели управления.
Список endpoint
Параметры
POST /api/v1/links — поля body:
GET /api/v1/links — параметры query:
Формат ошибок
Каждая ошибка возвращает HTTP-код состояния (401, 404, 409, 422, 429) и единую структуру JSON:
{ "error": "alias_taken", "message": "Этот алиас зарезервирован или уже занят." }
Частые коды: unauthorized (401), not_found (404), alias_taken (409), invalid_url / invalid_alias / invalid_expires_at / invalid_starts_at (422), rate_limited (429).
Ограничения
Пример запроса
Пример создания короткой ссылки на cURL:
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/очень/длинный/путь",
"alias": "promo",
"title": "Весенняя кампания",
"expires_at": "2026-12-31 23:59:59"
}'
Webhook
Зарегистрируйте endpoint в разделе Webhook панели управления — и при каждом выбранном событии мы отправим POST с JSON на ваш URL. Ответ 2xx считается успешным; иначе мы повторим до 3 раз с задержкой от 1 минуты до 10 минут. После 10 неудач подряд webhook отключается автоматически.
Структура каждой доставки (пример):
{
"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/очень/длинный/путь", "title": "Весенняя кампания",
"clicks": 0, "active": true, "state": "ok",
"created_at": "2026-07-18 09:30:00", "expires_at": "2027-07-18 09:30:00"
}
}
}
Проверка подписи
Каждая доставка приходит с такими заголовками: X-Quik-Event (название события), X-Quik-Signature — sha256=HMAC_SHA256(body, secret). Secret показывается только один раз — при создании вебхука. ОБЯЗАТЕЛЬНО проверяйте подпись по необработанному (raw) body и только сравнением за постоянное время:
<?php
// PHP — проверка подписи по сырому (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) — проверка подписи по сырому (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);
});
Ограничения: на тарифе Free — 1 вебхук, на Pro — 3, на Business — 10. Endpoint должен быть общедоступным адресом http/https (внутренние сетевые адреса запрещены).
