API hujjatlari

API bilan tanishish

API nomi, qisqa qo‘llanma, versiyalangan API bazasi va hujjatlar havolasini qaytaradi.

curl -H "Accept: application/json" https://cdn.dnorqobulov.uz/api

{
    "contractVersion": "discovery-v1",
    "name": "dnorqobulov API",
    "description": "dnorqobulov.uz platformasining API kirish nuqtasi. API bilan tanishing va dastlabki GET so‘rovingizni yuboring.",
    "apiBase": "/api/v1",
    "status": "discovery-only",
    "docs": {
        "href": "/api/docs",
        "title": "API hujjatlari"
    }
}

Hujjatlar katalogi

Ishlaydigan endpointlar, boshlash qo‘llanmasi va xato kodlarini JSON ko‘rinishida qaytaradi.

curl -H "Accept: application/json" https://cdn.dnorqobulov.uz/api/docs

{
    "contractVersion": "discovery-docs-v1",
    "overview": {
        "name": "dnorqobulov API"
    }
}

Ochiq kirish

Bu ikki endpoint uchun token yoki ro‘yxatdan o‘tish kerak emas. Faqat GET ishlaydi; body va query yubormang.

Versiyalar

Discovery javobi discovery-v1, hujjatlar discovery-docs-v1 kontraktidan foydalanadi. /api/v1 kelajak domain operatsiyalari uchun ajratilgan; hozir bu yo‘llar faol emas.

Javoblar va cheklovlar

Javoblar JSON va Cache-Control: no-store bilan keladi. Manzil 2 KiB, javob 32 KiB bilan chegaralangan. X-Request-ID muammoni aniqlashda yordam beradi.

MVP doirasi

Hozir API tanishtiruvi va hujjatlar ishlaydi. Login, admin, ma’lumot yozish, domain endpointlari va Telegram integratsiyasi keyingi bosqichlarda qo‘shiladi.

Xato kodlari

Xato javobida error.code, error.message, error.retryable va requestId bo‘ladi.