مستندات SimLab / راهنمای درگاه‌ها

فهرست مستندات
آماده شبیه‌سازیREST v1

مستندات زیبال

پروفایل محدود ZIBAL_REST_V1 فقط خرید معمولی ریالی را شبیه‌سازی می‌کند. این پروفایل بر مستندات و نمونه‌کدهای زیبال تکیه دارد و گواهی اتصال به درگاه زنده نیست. merchant و SimLabMerchantProof ساختگی را فقط در سرور پذیرنده نگه دارید.

مسیرهای اتصال

BASE=https://<simlab-host>/api/sandbox/zibal/<connection-id>
REQUEST=$BASE/v1/request
START=$BASE/start/<trackId>
VERIFY=$BASE/v1/verify
INQUIRY=$BASE/v1/inquiry

درخواست و بازگشت

درخواست JSON شامل merchant، amount ریالی بیش از ۱۰۰۰، callbackUrl و orderId اختیاری است. هدر X-SimLab-Merchant-Proof فقط برای درخواست‌های سروری است. پاسخ موفق result=100 و trackId دارد. مرورگر با Referer هم‌مبدأ با callbackUrl به START می‌رود. صفحه آزمایشی اطلاعات کارت نمی‌گیرد و با GET شامل موفقیت، trackId، status و orderId اختیاری برمی‌گردد. این بازگشت فقط راهنما است.

تأیید و استعلام

پس از بازگشت، سرور پذیرنده تأیید را با merchant، trackId و proof فراخوانی می‌کند. فقط result=100 یا تکرار موفق result=201 همراه با مبلغ و refNumber منطبق پرداخت را تأیید می‌کند. استعلام وضعیت فعلی را بدون تغییر پرداخت برمی‌گرداند. پنجره آغاز ده دقیقه و تأیید سی دقیقه پس از پرداخت، سیاست همین شبیه‌ساز است. پرداخت تقسیمی، بازگشت وجه، برگشت، اطلاعات کارت و ارسال به زیبال واقعی پشتیبانی نمی‌شود.

نمونه درخواست سروری

مقدارهای آغازشده با YOUR_ و جای‌نگهدارهای امضا یا پاکت رمزنگاری را پیش از ارسال با اعتبارنامه ساختگی اتصال خود و محاسبه صحیح جایگزین کنید. این نمونه اطلاعات هیچ حسابی را شامل نمی‌شود. زمان و تاریخ درخواست را هنگام ارسال تازه کنید و امضا را از روی همان بدنه نهایی بسازید. نشانی بازگشت نمونه را هم با نشانی سایت آزمایشی خود عوض کنید.

روش، مسیر و هدرهای درخواست

POST /v1/request
Content-Type: application/json
X-SimLab-Merchant-Proof: YOUR_SimLabMerchantProof
بدنه درخواست آزمایشی

{
  "merchant": "YOUR_merchant",
  "amount": "250000",
  "callbackUrl": "https://merchant.example.test/payment/callback",
  "orderId": "ORDER9001"
}

چک‌لیست اتصال و نهایی‌سازی

شناسه اتصال و اعتبارنامه ساختگی را از صفحه همین درگاه در داشبورد بردارید. مسیر سرویس را به SimLab تغییر دهید؛ نشانی بازگشت باید متعلق به سایت آزمایشی شما و در مرورگر قابل دسترس باشد. حروف بزرگ و کوچک نام فیلدها، روش HTTP و نوع بدنه را دقیقاً مطابق همین پروفایل نگه دارید.

شروع صفحه پرداخت
trackId پاسخ را با GET به /start/<trackId> ببرید؛ Referer مرورگر باید هم‌مبدأ callbackUrl باشد.
بازگشت به سایت
GET مرورگر با success، trackId، status و orderId اختیاری؛ موقت است.
اطلاعاتی که باید نگه دارید
orderId، amount و trackId را نگه دارید و پاسخ Verify را با آنها تطبیق دهید.
معیار نهایی موفقیت
POST /v1/verify با merchant، trackId و proof؛ result=100 یا تکرار موفق 201 با مبلغ/refNumber منطبق نهایی است.
درخواست تکراری
orderId ارائه‌شده با داده یکسان بازپخش می‌شود؛ بدنه متفاوت تعارض. بدون orderId هر درخواست پرداخت تازه است.
مهلت‌ها
Start تا ده دقیقه؛ Verify تا سی دقیقه پس از پرداخت.
عملیات قابل استفاده
ایجاد درخواست، صفحه پرداخت، تأیید و استعلام وضعیت فعلی
خارج از محدوده
تسهیم، برگشت، بازپرداخت و کارت واقعی

خطا در کدام مرحله رخ داده است؟

  • پیش از دریافت توکن: مسیر، نوع بدنه، مبلغ و واحد پول، اعتبارنامه و امضای درخواست را بررسی کنید. پاسخ HTTP موفق به‌تنهایی کافی نیست؛ کد نتیجه داخل بدنه نیز باید مطابق قرارداد موفق باشد.
  • هنگام ورود به صفحه پرداخت: توکن همان اتصال، روش GET یا POST و اعتبار زمانی آن را بررسی کنید. کلید سروری را در فرم مرورگر یا نشانی صفحه قرار ندهید.
  • هنگام بازگشت: نشانی ثبت‌شده، روش فرم یا پارامترهای نشانی و تطابق شناسه سفارش را بررسی کنید. ایجاد فرم بازگشت به معنی دریافت آن توسط سایت شما نیست؛ مرورگر ممکن است بسته شود.
  • هنگام تأیید: مرجع، مبلغ و پایانه را از سفارش ذخیره‌شده بخوانید و با پاسخ تطبیق دهید. ورودی بازگشت مرورگر قابل دست‌کاری است. خطای شبکه یا پایان مهلت را به پرداخت موفق تبدیل نکنید.
  • پس از تأیید: اگر این پروفایل تسویه یا تأیید نهایی جدا دارد، آن را اجرا کنید. تکرار درخواست را طبق قواعد همین درگاه انجام دهید؛ برای همه درگاه‌ها قاعده تکرار یکسان وجود ندارد.

در تاریخچه درخواست‌ها، مرحله، کد HTTP و نتیجه فنی را کنار تراکنش مرتبط ببینید. شناسه درخواست برای پیگیری مفید است؛ کلید، رمز، توکن دسترسی و امضا را در پیام پشتیبانی قرار ندهید. رد شدن دسترسی ممکن است به حساب، اشتراک، اتصال یا اعتبارنامه مربوط باشد؛ پاسخ عمومی عمداً علت خصوصی حساب را افشا نمی‌کند.

سناریوهای آزمایش و دسترسی

درخواست ایجاد پرداخت را از سرور سایت خود بفرستید. در صفحه‌ی پرداخت آزمایشی، نتیجه‌ی دلخواه را همان‌جا انتخاب کنید: موفقیت، انصراف، خطای درگاه یا پایان مهلت. نتیجه از قبل انتخاب نمی‌شود. سپس بازگشت و تأیید سروری را در جزئیات همان پرداخت بررسی کنید.

پیش‌نمایش ادمین ورودی مبلغ، سفارش و خطای دلخواه دارد و حالت‌های نمایشی بیشتری را نشان می‌دهد؛ تراکنش یا بازگشت واقعی نمی‌سازد. حالت‌هایی مانند موجودی ناکافی یا رمز نامعتبر در آن، نمایش رابط‌اند و نباید به‌عنوان کد قطعی قرارداد همه درگاه‌ها تعبیر شوند. با پایان اشتراک، تعلیق حساب یا غیرفعال شدن اتصال، عملیات جدید و بازپخش درخواست‌های قبلی دوباره کنترل و ممکن است رد شوند؛ تاریخچه متعلق به شما خواندنی می‌ماند.

باز کردن اتصال و بخش آزمایش این درگاه · تاریخچه درخواست‌ها و تراکنش‌ها · راهنمای اولین اتصال

مرز ایمنی

هیچ اعتبارنامه محیط عملیاتی، کلید خصوصی یا اطلاعات کارت واقعی را برای این شبیه‌ساز استفاده نکنید. این قرارداد محدود SimLab ادعای گواهی همه نسخه‌های فعلی بانک نیست.

نمای عمومی درگاه