АПЫ бойынша есептер
Планфіх РЕСТ АПЫ арқылы есеп деректерін алу үшін екі тәсіл ұсынады:
- жоспарланған есеп жасап, оның деректерін РЕСТ АПЫ арқылы алуға болады.
- Немесе есеп жасалуын РЕСТ АПЫ арқылы шақырып, деректер дайын бола салысымен оларды ала аласыз.
Толық РЕСТ АПЫ сипаттамасын мұнда табуға болады.
РЕСТ АПЫ арқылы жоспарланған есептен деректерді алу
- Қайталанатын есеп жасаңыз.
- Есепті жіберуді жоспарлайтын қызметкер үшін авторизациялық токен жасаңыз. Сақталған есеп деректері тек сіз таңдаған қызметкерлерге қолжетімді болады. Токен жасау үшін Есептік жазба басқару — АПЫ-ға қолжетім, — РЕСТ АПЫ — Жаңа токен жасау мәзіріне өтіңіз:
- Емплоее / Цонтацт өрісінде жоспарланған есепті алатын қызметкерді көрсетіңіз.
- Аллоуед Сцопес өрісіне репорт_реадонлy енгізіңіз.
- РЕСТ АПЫ арқылы есептер тізімін алу үшін /репорт/ліст әдісін пайдаланып, жауаптан қажетті есептің ЫД-сін табыңыз (есептің ЫД-сін шолғыштың мекенжай жолағынан да табуға болады).
- Таңдалған есептің сақталған нұсқалары тізімін алу үшін /репорт/{ід}/саве/ліст әдісін шақырыңыз.
- Жаңа нұсқаның ЫД-сі бойынша есеп деректерін алу үшін /репорт/{ід}/саве/{савеЫд}/дата әдісін пайдаланыңыз.
Деректерді алу бойынша ескертулер
- Сақталған есеп деректері тек сіз таңдаған қызметкерлерге қолжетімді.
- Егер есеп үлкен болса, нұсқа бірнеше бөліктен (цһұнк) тұруы мүмкін. Есеп деректерін алу кезінде барлық бөлімдерді алу үшін цһұнк индексін беру қажет. Есептегі бөлімдер санын анықтау үшін /репорт/[ід]/саве/ліст әдісін пайдалана аласыз.
РЕСТ АПЫ арқылы есептерді генерациялау
- Есепті жіберуді жоспарлайтын қызметкер үшін авторизациялық токен жасаңыз. Сақталған есеп деректері тек сіз таңдаған қызметкерлерге қолжетімді болады. Токен жасау үшін Есептік жазба басқару — АПЫ-ға қолжетім — РЕСТ АПЫ — Жаңа токен жасау мәзіріне өтіңіз:
- Емплоее / Цонтацт өрісінде есепті қабылдайтын қызметкерді көрсетіңіз.
- Аллоуед Сцопес өрісіне репорт_реадонлy енгізіңіз.
- Есеп генерациясын шақыру үшін /репорт/{ід}/генерате соңғы нүктесін пайдаланыңыз. Жауапта реқұестЫд қайтарады.
- Қысқа уақыттан кейін есептің статусын /репорт/статұс/{реқұестЫд} арқылы тексеріңіз.
Егер есеп дайын болса, жауапта РепортСаве объектісі (жоспарланған есептердегідей формат) болады.
- Сақталған нұсқаның ЫД-сі бойынша есеп деректерін алу үшін /репорт/{ід}/саве/{савеЫд}/дата әдісін шақырыңыз.
Генерацияға қойылатын шектеулер
- Тек Корпоративтік тарифте қолжетімді.
- Есептер ең көбі әр 10 минут сайын ғана генерациялануы мүмкін.
- Аккаунт бойынша бір уақытта тек бір есеп генерациялануы мүмкін.
- Есептер АПЫ токенмен байланысты пайдаланушы атынан генерацияланады, сондықтан сол пайдаланушының қолжетімділік рұқсаттары қолданылады.