مستندات API
اعتبار جبرانی: تعهد نرخ موفقیت API
برای هر خانوادهٔ سازنده و هر ماه شمسی (به وقت تهران)، از آذر ۱۴۰۵ به بعد، نرخ موفقیت درخواستهای دروازه سنجیده میشود. در این نرخ فقط شکستهایی شمرده میشود که از طرف ما بوده، نه قطعی یا خطای خود سازنده. هدف ۹۹.۵٪ است. اگر نرخ ماه زیر هدف باشد، درصدی از آنچه کیف پولت برای تماسهای آن سازنده در آن ماه پرداخته بهصورت اعتبار به کیف پول برمیگردد. ارقام هر ماه پیش از پرداخت را تیم ما بررسی میکند و اعتبار ظرف ۵ روز پس از پایان ماه پرداخت میشود، بیآنکه لازم باشد درخواستی بدهی. این تعهد دربارهٔ نرخ موفقیت است، نه سرعت و نه کیفیت خروجی.
آخرین بهروزرسانی:
فهرست مستندات
مسیرهای API
حساب، کلید و تیم
اعتبار جبرانی · ۱
پلههای اعتبار
| نرخ موفقیت ماه | اعتبار |
|---|---|
| زیر ۹۹.۵٪ | ۱۰٪ خرج آن ماه روی آن سازنده |
| زیر ۹۸٪ | ۱۵٪ خرج آن ماه روی آن سازنده |
| زیر ۹۵٪ | ۲۰٪ خرج آن ماه روی آن سازنده |
| زیر ۹۰٪ | ۲۵٪ خرج آن ماه روی آن سازنده |
- نرخی که دقیقاً روی یک آستانه باشد زیر آن حساب نمیشود. نرخ منتشرشده دو رقم اعشار دارد و همیشه به پایین گرد میشود.
- درصد روی مبلغی اعمال میشود که کیف پول تو برای تماسهای آن سازنده در آن ماه پرداخته، پس از کسر برگشتیهای همان تماسها. مصرفی که از اعتبار پلن یا اعتبار هدیه پرداخت شده شمرده نمیشود.
- اعتبار روی هر مدلی خرج میشود، منقضی نمیشود، و قابل برداشت یا برگشت نیست.
اعتبار جبرانی · ۲
چطور سنجیده میشود
- ماه، ماه شمسی به وقت تهران است، از نخستین لحظهٔ روز اول تا پایان روز آخر. تعهد از آذر ۱۴۰۵ شروع میشود و ماههای پیش از آن را نمیپوشاند.
- موفقیت و شکست مثل صفحهٔ وضعیت خوانده میشود: موفقیت یعنی پاسخ
2xx؛ شکست یعنی5xxیا درخواستی بدون پاسخ. خطای4xxکه از خود درخواست است (بدنهٔ نادرست، مدل ناشناخته، سقف نرخ خودت، کیف پول خالی) نه شکست است و نه در مخرج. - نرخ اعتبار فقط شکستهایی را میشمارد که از طرف ما بوده: خطای خود دروازه یا سرورها و مسیرهای ما، و خطای سازندهای که علتش حساب ما نزد آن سازنده است (اعتبار یا سهمیهٔ حساب ما تمام شده، کلید یا حساب ما باطل یا معلق شده، یا به سقف نرخ حساب ما نزد او رسیدهایم). قطعی یا خطای خود سازنده، وقتی حساب ما نزد او سالم است، نه شکست شمرده میشود و نه در مخرج میآید؛ درخواستی هم که خود سازنده اتصالش را قطع کرده یا نپذیرفته همینطور است. اما قطعی که زمانسنج خود ما انجام دهد (مهلت ما، مثلاً برای نخستین پاسخ) شکست از طرف ما شمرده میشود. پس نرخ اعتبار برابر است با موفقها ÷ (موفقها + شکستهای از طرف ما). در این صفحه «درخواست واجد شرایط» یعنی درخواستی که در مخرج نرخ اعتبار است.
- صفحهٔ تعهد پایداری برای هر سازنده و هر ماه بستهشده هر دو نرخ را نشان میدهد: نرخ موفقیت (همان نرخ صفحهٔ وضعیت) و نرخ اعتبار. پله و اعتبار را نرخ اعتبار تعیین میکند.
- حساب باید در آن ماه دستکم ۱۰۰ درخواست واجد شرایط به آن سازنده داشته باشد و هنگام پرداخت فعال باشد.
- سازندهای که در ماه کمتر از ۱٬۰۰۰ درخواست واجد شرایط از همهٔ مشتریها داشته باشد سنجیده نمیشود و صفحه همین را میگوید.
اعتبار جبرانی · ۳
پرداخت
- پس از بسته شدن هر ماه، تیم ما ارقام آن (نرخ هر سازنده و اعتبار هر حساب) را بررسی میکند و اعتبار پس از این بررسی، ظرف ۵ روز پس از پایان ماه، به کیف پول پرداخت میشود. لازم نیست درخواستی بدهی.
- تا بررسی ماهی تمام نشده، اعتباری از آن ماه نشان داده نمیشود. ردیفی که
pendingاست اعتباری است که با وضع فعلی حتماً پرداخت میشود. - تعهد با عددهای فعلیاش و نرخ هر سازنده در ماههای بستهشده در صفحهٔ تعهد پایداری است؛ اعتبارهای خودت در تاریخچهٔ اعتبارهای جبرانی و در
GET /v1/sla/credits.
اعتبار جبرانی · ۴
خواندن اعتبارها: GET /v1/sla/credits
GET /v1/sla/credits
curl "https://1xai.ir/v1/sla/credits?limit=50" \
-H "Authorization: Bearer 1xai-..."- پاسخ:
active(تعهد اکنون برقرار است)،total_paid_toman(جمع ردیفهایpaidهمین صفحه) وcredits، تازهترین ماه اول. - هر ردیف یک ماه و یک سازنده است:
period(ماه شمسی،YYYY-MM)،provider،rate_pct،status_rate_pct،eligible_requests،ok_requests،spend_toman،credit_pct،credit_toman،state(paidیاpending)،paid_atوwallet_transaction_id. - در هر ردیف
rate_pctوeligible_requestsوok_requestsمال نرخ اعتبار است (بخش «چطور سنجیده میشود») وcredit_pctاز همین نرخ میآید؛ نرخ صفحهٔ وضعیت برای همان ماه و سازنده درstatus_rate_pctاست. credit_tomanبرابر است باspend_toman × credit_pct ÷ ۱۰۰، گردشده به پایین.- ماهی که اعتباری برایت ندارد ردیفی ندارد. تراکنش پرداخت در
GET /v1/wallet/transactionsبا نوعgiftهست. - اعتبار مال حسابی است که پرداخت میکند و روی کل خرج کیف پول شرکت حساب میشود، نه هر فضای کاری؛ پس کلید فضای کاری شرکت برای این مسیر پاسخ
403با کدforbiddenمیگیرد.