در حالِ بارگذاریِ کاروان…
راهنمای جامعِ APIهای پلتفرمِ کاروانی برای توسعهدهندگان، شرکای تجاری و ادغامهای شخص ثالث. تمامیِ endpointها از طریقِ HTTPS و با امضای HMAC در نشست عمل میکنند.
• نشستها از طریقِ کوکیِ HttpOnly با امضای HMAC-SHA256 و TTL ۳۰ روز مدیریت میشوند.
• برای endpointهای ادمین، نقشِ admin و احتمالاً واحدِ سازمانیِ مشخص (super/finance/operations/…) لازم است.
• تمامیِ پاسخها در فرمت application/json با charset utf-8 برمیگردند.
• خطاها بهصورتِ {error: string} با HTTP statusِ مناسب (4xx/5xx) برمیگردند.
هر webhook با header X-Carvani-Signature: sha256=... امضا میشود. برای اعتبارسنجی، payload خام را با secret خود HMAC-SHA256 کنید و با signature مقایسه نمایید.
POST /your-webhook HTTP/1.1
Content-Type: application/json
X-Carvani-Event: order.created
X-Carvani-Signature: sha256=ab47c2...
{
"event": "order.created",
"timestamp": "2026-05-27T10:30:00.000Z",
"data": { ... }
}/api/auth/send-otpارسالِ کدِ OTPعمومی10/15min/IP/api/auth/login-otpتأییدِ کد و ورودعمومی15/15min/IP/api/auth/login-passwordورود با رمز عبورعمومی8/15min/IP/api/auth/registerثبتنامعمومی5/hour/IP/api/auth/logoutخروج و revoke نشستمشتری/api/bannersبنرهای فعالِ صفحهی اصلیعمومی/api/product-questions/[slug]پرسش و پاسخِ یک محصولعمومی/api/product-questions/[slug]ثبتِ پرسشِ جدیدمشتری5/hour/IP/api/account/walletsموجودی کیفپولهامشتری/api/account/addressesآدرسهای ذخیرهشدهمشتری/api/account/orders/[code]جزئیاتِ یک سفارشمشتری/api/account/loyaltyامتیاز و سطحِ باشگاهمشتری/api/account/sessionsنشستهای فعالمشتری/api/account/sessions?jti=…خروج از یک دستگاهمشتری/api/account/notification-prefsتنظیماتِ اعلاناتمشتری/api/account/exportخروجیِ کاملِ دادهها (GDPR)مشتری/api/account/deleteحذفِ حساب (با OTP)مشتری/api/account/ticketsایجادِ تیکتِ پشتیبانیمشتری5/hour/IP/api/admin/customersلیست مشتریانادمین/api/admin/customers/[phone]block/unblock/notesادمین/api/admin/adminsلیست ادمینها (super-only)ادمین/api/admin/ticketsصندوقِ ورودیِ تیکتهاادمین/api/admin/refundsجستوجوی تراکنشها (finance)ادمین/api/admin/audit/csvخروجی CSV گزارش تغییراتادمین/api/admin/newsletter/csvخروجی CSV مشترکین خبرنامهادمین/api/admin/orders/[code]/tax-invoiceارسال به سامانه مودیانادمین/api/admin/webhooksلیست webhookها (super-only)ادمین/api/admin/webhooksایجادِ webhook جدیدادمین/api/admin/webhooks/[id]enable/disableادمین/api/admin/webhooks/[id]حذف webhookادمین/api/healthوضعیتِ سلامتِ سیستم (DB/SMS/Email/Credit)عمومی/api/newsletterثبتنام در خبرنامهعمومی5/hour/IPبرای پشتیبانی توسعهدهنده، با dev@carvani.ir تماس بگیرید.