API бойынша есептер
Planfix REST API арқылы есеп деректерін алу үшін екі тәсіл ұсынады:
- жоспарланған есеп жасап, оның деректерін REST API арқылы алуға болады.
- Немесе есеп жасалуын REST API арқылы шақырып, деректер дайын бола салысымен оларды ала аласыз.
Толық REST API сипаттамасын мұнда табуға болады.
REST API арқылы жоспарланған есептен деректерді алу
- Қайталанатын есеп жасаңыз.
- Есепті жіберуді жоспарлайтын қызметкер үшін авторизациялық токен жасаңыз. Сақталған есеп деректері тек сіз таңдаған қызметкерлерге қолжетімді болады. Токен жасау үшін Есептік жазба басқару — API-ға қолжетім, — REST API — Жаңа токен жасау мәзіріне өтіңіз:
- Employee / Contact өрісінде жоспарланған есепті алатын қызметкерді көрсетіңіз.
- Allowed Scopes өрісіне report_readonly енгізіңіз.
- REST API арқылы есептер тізімін алу үшін /report/list әдісін пайдаланып, жауаптан қажетті есептің ID-сін табыңыз (есептің ID-сін шолғыштың мекенжай жолағынан да табуға болады).
- Таңдалған есептің сақталған нұсқалары тізімін алу үшін /report/{id}/save/list әдісін шақырыңыз.
- Жаңа нұсқаның ID-сі бойынша есеп деректерін алу үшін /report/{id}/save/{saveId}/data әдісін пайдаланыңыз.
Деректерді алу бойынша ескертулер
- Сақталған есеп деректері тек сіз таңдаған қызметкерлерге қолжетімді.
- Егер есеп үлкен болса, нұсқа бірнеше бөліктен (chunk) тұруы мүмкін. Есеп деректерін алу кезінде барлық бөлімдерді алу үшін chunk индексін беру қажет. Есептегі бөлімдер санын анықтау үшін /report/[id]/save/list әдісін пайдалана аласыз.
REST API арқылы есептерді генерациялау
- Есепті жіберуді жоспарлайтын қызметкер үшін авторизациялық токен жасаңыз. Сақталған есеп деректері тек сіз таңдаған қызметкерлерге қолжетімді болады. Токен жасау үшін Есептік жазба басқару — API-ға қолжетім — REST API — Жаңа токен жасау мәзіріне өтіңіз:
- Employee / Contact өрісінде есепті қабылдайтын қызметкерді көрсетіңіз.
- Allowed Scopes өрісіне report_readonly енгізіңіз.
- Есеп генерациясын шақыру үшін /report/{id}/generate соңғы нүктесін пайдаланыңыз. Жауапта requestId қайтарады.
- Қысқа уақыттан кейін есептің статусын /report/status/{requestId} арқылы тексеріңіз.
Егер есеп дайын болса, жауапта ReportSave объектісі (жоспарланған есептердегідей формат) болады.
- Сақталған нұсқаның ID-сі бойынша есеп деректерін алу үшін /report/{id}/save/{saveId}/data әдісін шақырыңыз.
Генерацияға қойылатын шектеулер
- Тек Корпоративтік тарифте қолжетімді.
- Есептер ең көбі әр 10 минут сайын ғана генерациялануы мүмкін.
- Аккаунт бойынша бір уақытта тек бір есеп генерациялануы мүмкін.
- Есептер API токенмен байланысты пайдаланушы атынан генерацияланады, сондықтан сол пайдаланушының қолжетімділік рұқсаттары қолданылады.