API bo‘yicha hisobotlar
Planfix REST API orqali hisobot ma'lumotlarini olish uchun ikki usulni taklif etadi:
- Siz rejalashtirilgan hisobot yaratib, uning ma'lumotlarini REST API orqali olishingiz mumkin.
- Yoki hisobot yaratishni REST API orqali ishga tushirib, u tayyor bo‘lishi bilan ma'lumotlarni olishingiz mumkin.
To‘liq REST API spetsifikatsiyasini bu yerda topishingiz mumkin.
REST API orqali rejalashtirilgan hisobotdan ma'lumot olish
- Takrorlanuvchi hisobot yarating.
- Hisobotni yuborishni rejalashtirgan xodim uchun avtorizatsiya tokenini yarating. Saqlangan hisobot ma'lumotlari faqat siz yuborishni tanlagan xodimlar uchun mavjud bo‘ladi. Token yaratish uchun Account Management — Access to API — REST API — Create a new token bo‘limiga o‘ting:
- Employee / Contact maydonida rejalashtirilgan hisobotni qabul qiladigan xodimni belgilang.
- Allowed Scopes maydoniga: report_readonly ni kiriting.
- REST API orqali hisobotlar ro‘yxatini /report/list metodidan foydalanib oling va javobdagi kerakli hisobot ID sini toping (hisobot ID sini brauzer manzil satridan ham ko‘rishingiz mumkin).
- Tanlangan hisobotning saqlangan versiyalari ro‘yxatini /report/{id}/save/list metodidan oling.
- Hisobot ma'lumotlarini yangi versiyaning ID si orqali /report/{id}/save/{saveId}/data metodi yordamida oling.
Ma'lumot olishga oid muhim jihatlar
- Saqlangan hisobot ma'lumotlari faqat siz yuborishni tanlagan xodimlar uchun mavjud.
- Agar hisobot katta bo‘lsa, versiya bir nechta qismdan (chunk) iborat bo‘ladi. Hisobot ma'lumotlarini olishda barcha qismlarni olish uchun chunk indeksini uzatishingiz kerak. Hisobotdagi chunklar sonini aniqlash uchun /report/[id]/save/list metodidan foydalanishingiz mumkin.
REST API orqali hisobot yaratish
- Hisobotni yuborishni rejalashtirgan xodim uchun avtorizatsiya tokenini yarating. Saqlangan hisobot ma'lumotlari faqat siz yuborishni tanlagan xodimlar uchun mavjud bo‘ladi. Token yaratish uchun Account Management — Access to API — REST API — Create a new token bo‘limiga o‘ting:
- Employee / Contact maydonida rejalashtirilgan hisobotni qabul qiladigan xodimni belgilang.
- Allowed Scopes maydoniga: report_readonly ni kiriting.
- /report/{id}/generate endpointi orqali hisobot yaratishni ishga tushiring. Javobda requestId qaytadi.
- Qisqa muddatdan so‘ng, hisobot holatini /report/status/{requestId} orqali tekshiring.
Agar hisobot tayyor bo‘lsa, javobda ReportSave obyekti (rejalashtirilgan hisobotlarda ishlatiladigan bilan bir xil format) qaytadi.
- Saqlangan versiyaning ID si orqali hisobot ma'lumotlarini /report/{id}/save/{saveId}/data metodi yordamida oling.
Yaratishga qo‘yiladigan cheklovlar
- Faqat Korporativ narxlash rejasi mavjud bo‘lgan hisoblar uchun.
- Hisobotlarni har 10 daqiqada bir marta ko‘p bo‘lmagan holda yaratish mumkin.
- Hisobotlardan har safar hisob bo‘yicha bir dona yaratilishi mumkin.
- Hisobotlar API token bilan bog‘langan foydalanuvchi nomidan yaratiladi va uning ruxsatlari qo‘llanadi.