Хөгжүүлэгчдэд зориулав

API баримт бичиг

Quik.mn REST API-аар холбоосыг програмчлан үүсгэж, удирдаж, статистикийг татаж аваарай.

Үндсэн хаяг

Бүх endpoint дараах үндсэн хаягнаас эхэлнэ:

https://quik.mn/api/v1

Баталгаажуулалт

Хүсэлт бүрдээ хянах самбараас авсан API түлхүүрээ Authorization толгойд оруулна:

Authorization: Bearer qk_live_...

Түлхүүрээ хэнд ч бүү дамжуул. Задарсан бол хянах самбараас дахин үүсгэнэ.

Endpoint жагсаалт

POST /api/v1/links Шинэ богино холбоос үүсгэх
GET /api/v1/links Холбоосуудын жагсаалт авах
GET /api/v1/links/{id} Нэг холбоосын мэдээлэл
PATCH /api/v1/links/{id} Холбоос засварлах
DELETE /api/v1/links/{id} Холбоос устгах
GET /api/v1/links/{id}/stats Холбоосын статистик
POST /api/v1/links/{id}/extend Хугацаа сунгах — body: {"days": 365} (1/7/30/90/180/365, дээд 1 жил)
GET /api/v1/links/{id}/qr QR код авах — ?format=png|svg&size=300&fg=0F172A&bg=FFFFFF
GET /api/v1/me Одоогийн бүртгэлийн мэдээлэл

Параметрүүд

POST /api/v1/links — body талбарууд:

url заавал Очих урт хаяг (http/https).
alias сонголт Захиалгат богино нэр (үсэг, тоо, - ба _; 1–64 тэмдэгт). «slug» гэж илгээсэн ч ойлгоно.
title сонголт Гарчиг (200 хүртэл тэмдэгт).
expires_at сонголт Дуусах хугацаа — ирээдүйн огноо (жиш. 2026-12-31 23:59:59). Дээд тал нь 1 жил; орхивол 1 жил. PATCH дээр null илгээвэл 1 жилээр шинэчлэгдэнэ.
expire_days сонголт Эсвэл хоногоор: 1/7/30/90/180/365. expires_at-аас амархан.
on_duplicate сонголт Мөн хаягт идэвхтэй холбоос байвал: "reuse" (үндсэн — хуучныг буцаана, reused:true талбартай) эсвэл "create" (шинээр үүсгэнэ). Alias зааж өгсөн үед үргэлж шинээр үүсгэнэ.

GET /api/v1/links — query параметрүүд:

limit Нэг хуудсанд буцаах тоо (1–100, анхны утга 25).
offset Алгасах мөрийн тоо (хуудаслалт).
q Хайлт — slug, гарчиг, урт хаягаас хайна.

Алдааны формат

Алдаа бүр HTTP статус код (401, 404, 409, 422, 429) болон нэгдсэн JSON бүтэцтэй ирнэ: 

{ "error": "alias_taken", "message": "That alias is reserved or already in use." }

Түгээмэл кодууд: unauthorized (401), not_found (404), alias_taken (409), invalid_url / invalid_alias / invalid_expires_at (422), rate_limited (429).

Хязгаарлалт

API түлхүүр бүрд минутад 60 хүсэлт
Хэтэрвэл 429 rate_limited хариу ирнэ — түр хүлээгээд дахин оролдоно уу.

Жишээ хүсэлт

Богино холбоос үүсгэх 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/very/long/path",
    "alias": "promo",
    "title": "Хаврын кампанит ажил",
    "expires_at": "2026-12-31 23:59:59"
  }'
API түлхүүрээ аваарай
Хянах самбарын API хэсгээс түлхүүр үүсгээд шууд эхлээрэй.
API түлхүүр авах