QOIDA VA TAVSIYALAR
Dasturchilar va tajribali foydalanuvchilar uchun, O`zb.Resp. ochiq ma'lumotlar portalida mashina o`qiydigan formatdagi ulkan axborot massivlarini qisqa muddatda olishlari uchun API orqali so`rov kiritish imkoniyati yaratilgan.
API yaratilish jarayonidadir, shuning uchun usullar ogohlantirishsiz o`zgartirilishi mumkin, ammo keyinchalik foydalanuvchilar bu haqda xabardor qilinadi.
APIdan foydalanish uchun foydalanuvchilar shaxsiy kalit olishlari talab etiladi, shaxsiy kalitni Portalda ro`yxatadan o`tilgach olish mumkin.
Kalitni olgach APIdan foydalanishingiz mumkin. Kalitni so`rov oxirida quydagi ko`rinishda kiritish lozim /?access_token=sizning kalitingiz. Misol uchun datasetlar ro`yxatini olish uchun so`rov quydagi ko`rinishda bo`lishi lozim http://data.gov.uz/uz/api/v1/json/dataset?access_key...sizning kalitingiz.
API so`rov yuzasidan topilgan ma'lumotlarni bir nechta formatda taqdim etadi. Hozircha quydagi formatlarda axborotlar mavjud:
- JSON (so`rov qatorida “json" ko`rinishdagi nom registr pastida joylashadi)
- XML (so`rov qatorida “xml" ko`rinishdagi nom registr pastida joylashadi)
- CSV (so`rov qatorida “csv" ko`rinishdagi nom registr pastida joylashadi)
SHU KUNGACHA QUYIDAGI SO`ROVLAR AMALGA OSHIRILGAN:
- API bosh sahifasi;
- Ochiq ma'lumotlar to`plami;
- Ochiq ma'lumotlar to`plamlari ro`yxati;
- Ochiq ma'lumotlar to`plamlari versiyalari;
- Ochiq ma'lumotlar to`plamlari versiyalar ro`yxati;
- Ochiq ma'lumotlar to`plamlari versiyalar strukturasi (tuzilishi);
- Ochiq ma'lumotlar to`plamlari versiyalarining fayl tarkibi;
- Tashkilotlar ro`yxati;
- Tashkilot;
- Tashkilotning ochiq ma'lumotlar to`plami ro`yxati;
- Mavzuli ruknlar ro`yxati;
- Mavzuli ruknlar ochiq ma'lumotlari to`plamining ro`yxati.
Ayrim so`rovlar uchun qo`shimcha filtrlashdan foydalanish imkoniyati yaratilgan. Har bir to`plam uchun mos filtrlar ro`yxati so`rov tavsifida berilgan.
Qo`shimcha filtrlash GET sozlamalari orqali amalga oshiriladi.
Misol uchun, ochiq ma'lumotlar to`plami ro`yxatini olish so`roviga «/uz/api/v1/json/dataset» qo`shimcha filtratsiya kiritish mumkin. “Iqtisodiyot" mavzusida barcha to`plamlarni olish uchun "sphere
" filtirini "5
" natijasi bilan kiritish lozim, "5" ushbu sohaning identifikatsion tartib raqamidir. Shunda yakuniy so`rov quyidagicha ko`rinishga ega bo`ladi:«/uz/api/v1/json/sphere/5». Barcha identifikatsion tartib raqamlarni «/uz/api/v1/json/sphere» so'rovi orqali olish mumkin. Agarda "organization" filtiri "1" natijasi bilan birga ishlatilsa, bu holda Adliya Vazirligiga oid barcha ma'lumotlar taqdim etiladi va yakuniy so`rov «/uz/api/v1/json/organization/1/dataset» ko`rinishida bo'ladi.
SO`ROVLAR MAQSADI VA TUZILISHI:
- API bosh sahifasi – so`rov API to`g`risida ma'lumot berishga mo`ljallangan, shular qatorida qo`shimcha ma'lumotlar, foydalanish shartlari va foydalanish mumki bo`lgan so`rovlar ro`yxati.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>»
</span>
- Ochiq ma'lumotlar to`plamlari ro`yxati – so`rov ochiq ma'lumotlar to`plamlari ro`yxatini olishga mo`ljallangan.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)/dataset>»
- Ochiq ma'lumotlar to`plami – so`rov ochiq ma'lumotlar to`plamini olishga mo`ljallangan.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/dataset/<dataset:\d+>»
- Ochiq ma'lumotlar to`plamlari versiyalarining ro`yxati – so`rov ochiq ma'lumotlar to`plamlari versiyalarining ro`yxatini olishga mo`ljallangan.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/dataset/<dataset:\d+>/version»
- Ochiq ma'lumotlar to`plamlari versiyalari – so`rov ochiq ma'lumotlar to`plamlari versiyalari to`g`risida batafsil ma'lumot olishga mo`ljallanga.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/dataset/<dataset:\d+>/version/<version:\d+>»
- Ochiq ma'lumotlar to`plamlari versiyalarining tuzilishi – so`rov ochiq ma'lumotlar to`plamlari versiyalarining tuzilishi haqida batafsil ma'lumot olishga mo`ljallangan.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/dataset/<dataset:\d+>/version/<version:\d+>/structure»
- Ochiq ma'lumotlar to`plamlari versiyasi faylining tarkibi – so`rov ochiq ma'lumotlar to`plamlari versiyasi faylining tarkibi to`g`risida ma'lumot olishga mo`ljallangan.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/dataset/<dataset:\d+>/version/<version:\d+>/content»
- Tashkilotlar ro`yxati – so`rov portalda ro`yxatdan o`tgan tashkilot haqida batafsil ma'lumotlar olishga mo`ljallangan.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/organization»
- Tashkilotlarning ochiq ma'lumotlar to`plamlari ro`yxati – so`rov tashkilotlarning ochiq ma'lumotlar to`plamlari ro`yxatini olishga mo`ljallangan.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/organization/<organization:\d+>/dataset»
- Ruknlar ro`yxati – so`rov ochiq ma'lumotlarning ruknlar ro`yxatini olishga mo`ljallangan.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/shpere/<shpere:\d+>/dataset»
- Rukn – so`rov ruknlar to`g`risida ma'lumot olishga mo`ljallangan.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/sphere»
- Ochiq ma'lumotlar ruknlari to`plamlarining to`yxati – so`rov ochiq ma'lumotlar ruknlari to`plamlarining to`yxatlarini olishga mo`ljallangan.
So`rov tuzilishi:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/shpere/<shpere:\d+>/dataset»