АПИ бўйича ҳисоботлар
Планфих РЕСТ АПИ орқали ҳисобот ма'лумотларини олиш учун икки усулни таклиф этади:
- Сиз режалаштирилган ҳисобот яратиб, унинг ма'лумотларини РЕСТ АПИ орқали олишингиз мумкин.
- Ёки ҳисобот яратишни РЕСТ АПИ орқали ишга тушириб, у тайёр бўлиши билан ма'лумотларни олишингиз мумкин.
Тўлиқ РЕСТ АПИ спецификациясини бу ерда топишингиз мумкин.
РЕСТ АПИ орқали режалаштирилган ҳисоботдан ма'лумот олиш
- Такрорланувчи ҳисобот яратинг.
- Ҳисоботни юборишни режалаштирган ходим учун авторизация токенини яратинг. Сақланган ҳисобот ма'лумотлари фақат сиз юборишни танлаган ходимлар учун мавжуд бўлади. Токен яратиш учун Аccоунт Манагемент — Аccесс то АПИ — РЕСТ АПИ — Cреате а неw токен бўлимига ўтинг:
- Эмплоеэ / Cонтаcт майдонида режалаштирилган ҳисоботни қабул қиладиган ходимни белгиланг.
- Аллоwед Сcопес майдонига: репорт_реадонлй ни киритинг.
- РЕСТ АПИ орқали ҳисоботлар рўйхатини /репорт/лист методидан фойдаланиб олинг ва жавобдаги керакли ҳисобот ИД сини топинг (ҳисобот ИД сини браузер манзил сатридан ҳам кўришингиз мумкин).
- Танланган ҳисоботнинг сақланган версиялари рўйхатини /репорт/{ид}/саве/лист методидан олинг.
- Ҳисобот ма'лумотларини янги версиянинг ИД си орқали /репорт/{ид}/саве/{савеИд}/дата методи ёрдамида олинг.
Ма'лумот олишга оид муҳим жиҳатлар
- Сақланган ҳисобот ма'лумотлари фақат сиз юборишни танлаган ходимлар учун мавжуд.
- Агар ҳисобот катта бўлса, версия бир нечта қисмдан (чунк) иборат бўлади. Ҳисобот ма'лумотларини олишда барча қисмларни олиш учун чунк индексини узатишингиз керак. Ҳисоботдаги чунклар сонини аниқлаш учун /репорт/[ид]/саве/лист методидан фойдаланишингиз мумкин.
РЕСТ АПИ орқали ҳисобот яратиш
- Ҳисоботни юборишни режалаштирган ходим учун авторизация токенини яратинг. Сақланган ҳисобот ма'лумотлари фақат сиз юборишни танлаган ходимлар учун мавжуд бўлади. Токен яратиш учун Аccоунт Манагемент — Аccесс то АПИ — РЕСТ АПИ — Cреате а неw токен бўлимига ўтинг:
- Эмплоеэ / Cонтаcт майдонида режалаштирилган ҳисоботни қабул қиладиган ходимни белгиланг.
- Аллоwед Сcопес майдонига: репорт_реадонлй ни киритинг.
- /репорт/{ид}/генерате эндпоинти орқали ҳисобот яратишни ишга туширинг. Жавобда реқуэстИд қайтади.
- Қисқа муддатдан сўнг, ҳисобот ҳолатини /репорт/статус/{реқуэстИд} орқали текширинг.
Агар ҳисобот тайёр бўлса, жавобда РепортСаве обекти (режалаштирилган ҳисоботларда ишлатиладиган билан бир хил формат) қайтади.
- Сақланган версиянинг ИД си орқали ҳисобот ма'лумотларини /репорт/{ид}/саве/{савеИд}/дата методи ёрдамида олинг.
Яратишга қўйиладиган чекловлар
- Фақат Корпоратив нархлаш режаси мавжуд бўлган ҳисоблар учун.
- Ҳисоботларни ҳар 10 дақиқада бир марта кўп бўлмаган ҳолда яратиш мумкин.
- Ҳисоботлардан ҳар сафар ҳисоб бўйича бир дона яратилиши мумкин.
- Ҳисоботлар АПИ токен билан боғланган фойдаланувчи номидан яратилади ва унинг рухсатлари қўлланади.