API boýınşa esepter
Planfix REST API arqılı esep derekterin alw üşin eki täsil usınadı:
- josparlanğan esep jasap, onıñ derekterin REST API arqılı alwğa boladı.
- Nemese esep jasalwın REST API arqılı şaqırıp, derekter daýın bola salısımen olardı ala alasız.
Tolıq REST API sïpattamasın munda tabwğa boladı.
REST API arqılı josparlanğan esepten derekterdi alw
- Qaýtalanatın esep jasañız.
- Esepti jiberwdi josparlaýtın qızmetker üşin avtorïzacïyalıq token jasañız. Saqtalğan esep derekteri tek siz tañdağan qızmetkerlerge qoljetimdi boladı. Token jasaw üşin Eseptik jazba basqarw — API-ğa qoljetim, — REST API — Jaña token jasaw mäzirine ötiñiz:
- Employee / Contact örisinde josparlanğan esepti alatın qızmetkerdi körsetiñiz.
- Allowed Scopes örisine report_readonly engiziñiz.
- REST API arqılı esepter tizimin alw üşin /report/list ädisin paýdalanıp, jawaptan qajetti eseptiñ ID-sin tabıñız (eseptiñ ID-sin şolğıştıñ mekenjaý jolağınan da tabwğa boladı).
- Tañdalğan eseptiñ saqtalğan nusqaları tizimin alw üşin /report/{id}/save/list ädisin şaqırıñız.
- Jaña nusqanıñ ID-si boýınşa esep derekterin alw üşin /report/{id}/save/{saveId}/data ädisin paýdalanıñız.
Derekterdi alw boýınşa eskertwler
- Saqtalğan esep derekteri tek siz tañdağan qızmetkerlerge qoljetimdi.
- Eger esep ülken bolsa, nusqa birneşe bölikten (chunk) turwı mümkin. Esep derekterin alw kezinde barlıq bölimderdi alw üşin chunk ïndeksin berw qajet. Eseptegi bölimder sanın anıqtaw üşin /report/[id]/save/list ädisin paýdalana alasız.
REST API arqılı esepterdi generacïyalaw
- Esepti jiberwdi josparlaýtın qızmetker üşin avtorïzacïyalıq token jasañız. Saqtalğan esep derekteri tek siz tañdağan qızmetkerlerge qoljetimdi boladı. Token jasaw üşin Eseptik jazba basqarw — API-ğa qoljetim — REST API — Jaña token jasaw mäzirine ötiñiz:
- Employee / Contact örisinde esepti qabıldaýtın qızmetkerdi körsetiñiz.
- Allowed Scopes örisine report_readonly engiziñiz.
- Esep generacïyasın şaqırw üşin /report/{id}/generate soñğı nüktesin paýdalanıñız. Jawapta requestId qaýtaradı.
- Qısqa waqıttan keýin eseptiñ statwsın /report/status/{requestId} arqılı tekseriñiz.
Eger esep daýın bolsa, jawapta ReportSave obʺyektisi (josparlanğan esepterdegideý format) boladı.
- Saqtalğan nusqanıñ ID-si boýınşa esep derekterin alw üşin /report/{id}/save/{saveId}/data ädisin şaqırıñız.
Generacïyağa qoýılatın şektewler
- Tek Korporatïvtik tarïfte qoljetimdi.
- Esepter eñ köbi är 10 mïnwt saýın ğana generacïyalanwı mümkin.
- Akkawnt boýınşa bir waqıtta tek bir esep generacïyalanwı mümkin.
- Esepter API tokenmen baýlanıstı paýdalanwşı atınan generacïyalanadı, sondıqtan sol paýdalanwşınıñ qoljetimdilik ruqsattarı qoldanıladı.