پلانکقرارداد مشترک
مسیرها روی مبدأ برنامه مدیریت قرار دارند. پاسخ JSON معمولاً وضعیت ۲۰۰ و هدر جلوگیری از کش دارد؛ خطا با error برمی‌گردد. نوع دسترسی هر مسیر در جدول مشخص شده است.
درخواست تغییردهنده به مبدأ یکسان نیاز دارد. بدنه عمومی JSON سقف ۱۵۰٬۰۰۰ بایت دارد و بعضی مسیرهای حساس سقف کوچک‌تر دارند. قیمت پروژه در قرارداد به ریال است.
جلسه و ورود
| روش و مسیر | ورودی و خروجی | دسترسی و خطای اصلی |
|---|---|---|
| GET /api/session | {connected, user}؛ user ممکن است null باشد | خواندن وضعیت؛ پاسخ ۲۰۰ |
| POST /api/auth/login | {email,password} → مرحله MFA | همان مبدأ؛ ۴۰۰ ورودی، ۴۰۱ ورود، ۴۰۳ عضویت، ۴۲۹ محدودیت، ۵۰۳ اتصال |
| POST /api/auth/verify | {factorId,code} → {user} و جلسه | ورود موقت؛ ۴۰۰، ۴۰۱، ۴۰۳، ۴۰۹ تغییر شبکه، ۴۲۹، ۵۰۳ |
| POST /api/auth/logout | داده الزامی ندارد → {ok:true} | همان مبدأ؛ پاک کردن کوکی‌های ورود |
پروژه، محتوا و رسانه
| روش و مسیر | قرارداد | دسترسی و خطای اصلی |
|---|---|---|
| GET /api/projects | {projects} مرتب بر اساس sort_order | عضو؛ ۴۰۱ / ۵۰۲ |
| POST /api/projects | {project} → {project} | عضو؛ ویراستار فقط پیش‌نویس؛ ۴۰۰ / ۴۰۱ / ۴۰۳ / ۴۰۹ |
| PATCH /api/projects | {project,expectedUpdatedAt} → {project} | نسخه الزامی؛ تعارض یا نشانی تکراری ۴۰۹ |
| GET /api/content | {record} یا record:null | عضو؛ ۴۰۱ / ۵۰۲ |
| PUT /api/content | {content,expectedUpdatedAt} → {record} | مالک/ناشر؛ حفظ سیاست نرخ؛ اختلاف نسخه ۴۰۹ |
| POST /api/media | فایل خام با Content-Type معتبر → {url} | عضو؛ ۴۰۰ فرمت، ۴۰۱ / ۴۰۳، ۴۱۳ حجم، ۵۰۲ ذخیره |
| GET /api/audit | {events} | مالک/ناشر؛ نبود مجوز ۴۰۳، دریافت ناموفق ۵۰۲ |
پرونده و تصاویر هویتی
ثبت بررسی تا ۵٬۰۰۰ و تغییر نوع و مرحله تا ۲٬۰۰۰ بایت می‌پذیرد. نسخه مثبت و یادداشت حداکثر ۱۰۰۰ نویسه است. checks شامل face_visible، card_readable و challenge_match است.
خطاهای عمومی این خانواده ۴۰۰ ورودی، ۴۰۱ جلسه، ۴۰۳ دسترسی، ۴۰۹ تعارض یا شرط پرونده و ۵۰۳ آماده نبودن سرویس است.
| روش و مسیر | قرارداد | دسترسی و اعتبارسنجی |
|---|---|---|
| GET /api/identity | بدون id فهرست؛ ?id=UUID جزئیات | مالک؛ شناسه معتبر |
| POST /api/identity | {id,version,decision,note,checks} | مالک؛ approve/reject؛ سه بررسی مدرک |
| PATCH /api/identity | {id,version,verification_type,review_stage} | مالک؛ identity یا identity_bank؛ مرحله معتبر |
| GET /api/identity/photo | ?id=UUID&kind=card یا selfie → تصویر | مالک؛ بدون کش؛ ۴۰۴ فایل، ۴۱۵ فرمت، ۵۰۳ سرویس |
برنامه دعوت
مبلغ و درصد رشته عددی هستند تا تبدیل دقیق انجام شود. سابقه معامله یا فرمان پرداخت از این API قابل ارسال نیست. مسیرهای تنظیم اتصال در مقاله API اتصال‌ها آمده‌اند.
| روش و مسیر | قرارداد | دسترسی |
|---|---|---|
| GET /api/referrals | برنامه و آمار دعوت | عضو مدیریت؛ ۴۰۱ / ۵۰۳ |
| PUT /api/referrals | {enabled,inviteRewardToman,tradeSharePercent,version} | مالک و همان مبدأ؛ تا ۴٬۰۰۰ بایت؛ ۴۰۰ / ۴۰۱ / ۴۰۳ / ۴۰۹ |