https://shabanic.ir/api/v1/sayad_check_color

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

{
  "nationalCode": "0829940049",
}

• nationalCode:کد ملی (اجباری)

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

SHABANIC-API-KEY

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

{
         "responseCode": "FN-CTFH-20099900000",
         "trackId": "1ccdb-4924-4ab4-9a61-9ed6573",
         "result": {
            "chequeColor": "2"
         },
         "status": "DONE"
     }

- در رشته JSON برگشت داده شده خروجی فرخوانی سرویس وضعیت رنگ چک برگشت داده می شود.

• result: آبجکتی از پاسخ سرویس شامل:
  • chequeColor: کد رنگ چک
    • 1: وضعیت سفید — صادرکننده فاقد هرگونه سابقه چک برگشتی بوده یا در صورت وجود، همه موارد رفع سوء اثر شده است.
    • 2: وضعیت زرد — دارای یک فقره چک برگشتی یا حداکثر مبلغ ۵۰ میلیون ریال تعهد برگشتی.
    • 3: وضعیت نارنجی — دارای دو تا چهار فقره چک برگشتی یا حداکثر مبلغ ۲۰۰ میلیون ریال تعهد برگشتی.
    • 4: وضعیت قهوه‌ای — دارای پنج تا ده فقره چک برگشتی یا حداکثر مبلغ ۵۰۰ میلیون ریال تعهد برگشتی.
    • 5: وضعیت قرمز — بیش از ده فقره چک برگشتی یا بیش از مبلغ ۵۰۰ میلیون ریال تعهد برگشتی.
• status: وضعیت فراخوانی سرویس
  • DONE: فراخوانی موفق سرویس
  • FAILED: فراخوانی ناموفق سرویس
• trackId: کد پیگیری؛ اگر از سمت کاربر ارسال شده باشد همان مقدار بازگردانده می‌شود، در غیر این صورت یک رشته تصادفی تولید می‌گردد.
• error: جزئیات خطا (در صورت بروز خطا)