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 ٴادىسىن شاقىرىڭىز.

گەنەراتسىيياعا قويىلاتىن شەكتەۋلەر

• تەك كورپوراتىيۆتىك تارىيفتە قولجەتىمدى.
• ەسەپتەر ەڭ كوبى ٴار ۱۰ مىينۋت سايىن عانا گەنەراتسىييالانۋى مۇمكىن.
• اككاۋنت بويىنشا ٴبىر ۋاقىتتا تەك ٴبىر ەسەپ گەنەراتسىييالانۋى مۇمكىن.
• ەسەپتەر API توكەنمەن بايلانىستى پايدالانۋشى اتىنان گەنەراتسىييالانادى، سوندىقتان سول پايدالانۋشىنىڭ قولجەتىمدىلىك رۇقساتتارى قولدانىلادى.

ٴوتۋ

• جوسپارلانعان ەسەپ
• ەسەپتەر
• فۋنكتسىييا سىيپاتتاماسى