https://shabanic.ir/api/v1/sayad_transfers_chain?sayadId=123456123456789456&chequeType=1&idCode=0829940049

گرچه با ایجاد درخواست و تعریف Url مرحله قبل پارامتر های لازم به صورت خودکار ایجاد می شوند اما در نظر داشته باشید باید طبق راهنمایی تصویر زیر باید پارامترهای ذکر شده را در بخش Params نرم افزار postman وجود داشته باشند

sayadId = 123456123456789456
chequeType = 1
idCode = 0829940049

• sayadId: (اجباری) شناسه صیاد چک
• chequeType: (اجباری) نوع چک
  • 1: عادی
  • 2: بانکی(چک تضمینی)
  • 3: رمز دار
  • 4: چک موردی
• idCode: (اجباری) کد شناسایی، مشتری حقیقی کد ملی٬ مشتری حقوقی شناسه ملی شرکت

- برای گرفتن پاسخ از هر سرویس شبانیک در بستر API باید از پنل کاربری خود در شبانیک و از منوی توسعه دهندگان-درخواست Api نسبت به ثبت درخواست API و گرفتن توکن امنیتی اقدام نمایید، سپس طبق تصویر زیر در سربرگ Headers یک کلید به نام SHABANIC-API-KEY ایجاد نمایید و توکن امنیتی که از شبانیک گرفته اید را در این متغییر کپی نمایید

SHABANIC-API-KEY

- پس از تعریف متغیر توکن امنیتی در Postman، بر روی گزینه Send کلیک کنید تا نتیجه استعلام سرویس برای شما نمایش داده شود. بسته به سرویسی که در حال دریافت API آن از شبانیک هستید، پاسخ متفاوتی دریافت خواهید کرد. به عنوان مثال، در این سرویس که مربوط به زنجیره انتقال چک صیادی تمامی بانک های کشور ایران است، پاسخ API شبانیک به صورت رشته‌ای از نوع JSON مطابق نمونه زیر ارائه می‌شود.

{
    "responseCode": "FN-CTKZ-20003200000",
    "trackId": "5948d3a1-e92b-4973-a4f0-426f9345f0bc",
    "result": {
        "chain": [
            {
                "customers": [
                    {
                        "name": "یحیی جعفری",
                        "idCode": "0829940049",
                        "idType": 1
                    }
                ],
                "roleType": 1
            },
            {
                "customers": [
                    {
                        "name": "سعید زارع",
                        "idCode": "0829632581",
                        "idType": 3
                    }
                ],
                "roleType": 3
            },
            {
                "customers": [
                    {
                        "name": "بانک صادرات",
                        "idCode": "10861736062",
                        "idType": 2
                    }
                ],
                "roleType": 2
            }
        ]
    },
    "status": "DONE",
    "shabanic_message": "این پاسخ شبیه‌سازی شده است و از محیط سندباکس شبانیک تولید شده است، اطلاعات واقعی نمی‌باشد، اطلاعات بیشتر در https://shabanic.ir/apis"
}

- در رشته JSON برگشت داده شده خروجی فرخوانی سرویس زنجیره انتقال چک صیادی برگشت داده می شود.

• responseCode: کد پاسخ دریافتی
• trackId: کد پیگیری که در فراخوانی سرویس فرستاده شده است.
• result: آبجکتی از پاسخ سرویس شامل:
  • chain: لیست اطلاعات هویتی فرد/افراد موجود در یک زنجیره از انتقالات چک که در جدول مشخصات افراد موجود در زنجیره انتقالات چک شرح داده شده است.
    • customers: در صورت وجود نام مشتری ذینفع در زنجیره انتقالات چک، در صورت عدم وجود مقدار خالی برگردانده می شود
      • name: در صورت وجود نام مشتری ذینفع در زنجیره انتقالات چک، در صورت عدم وجود مقدار خالی برگردانده می شود
      • idCode: کد شناسایی دارنده چک مشتری حقیقی: کد ملی مشتری حقوقی: شناسه ملی شرکت
      • idType: نوع کد شناسایی: 1:مشتری حقیقی 2:مشتری حقوقی 3: اتباع بیگانه حقیقی 4: اتباع بیگانه حقوقی
    • roleType: نوع شخص
      • 1: صادرکننده چک
      • 2: گیرنده چک (دریافت کننده چک)
      • 3: گیرنده انتقال
• status: وضعیت فراخوانی سرویس
  • DONE: فراخوانی موفق سرویس
  • FAILED: فراخوانی ناموفق سرویس
• error: جزییات خطا (در صورت بروز خطا)