مستندات API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی)

مستندات API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی) | راهنمای کامل استفاده

در این صفحه می‌توانید راهنمای کامل استفاده از API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی) را مشاهده کنید. شامل پارامترهای ورودی، نمونه درخواست CURL، خروجی پاسخ، کدهای آماده و ویدئوی آموزشی برای درک بهتر عملکرد سرویس و استفاده آسان در پروژه‌های خود است. این مستندات به شما کمک می‌کند تا API را به‌صورت دقیق و سریع پیاده‌سازی کنید و از تمام قابلیت‌های سرویس بهره‌مند شوید.

📝 توضیحات سرویس

با این API می‌توانید با وارد کردن اطلاعات هویتی یک فرد، گزارش دقیق و رسمی اعتبارسنجی بانکی او را دریافت کنید. خروجی شامل بررسی رفتار مالی، سوابق بازپرداخت تسهیلات، نقش فرد در قراردادهای بانکی، بدهی‌ها، وثایق ثبت‌شده، استعلام‌های انجام‌شده، بدهی‌های شهرداری، خریدهای اقساطی و شاخص‌های ریسک اعتباری است. این سرویس به شما امکان می‌دهد خوش‌حسابی یا بدحسابی افراد را به‌صورت لحظه‌ای ارزیابی کرده و شانس دریافت یا ارائه تسهیلات را دقیق بسنجید. نکته مهم: این سرویس شامل 4 مرحله اجرایی است و باید تمامی مراحل به دقت پیاده‌سازی شود. لطفاً ویدئوی راهنمای استفاده از API را پیش از شروع مشاهده کنید.

🏷️ CURL

📡 POST api/v1/repayment_validation

مرحله اول:
curl --location 'https://shabanic.ir/api/v1/repayment_validation_request_otp' \
--header 'SHABANIC-API-KEY: {توکن API شبانیک}' \
--header 'Content-Type: application/json' \
--data '{
    "nationalCode":"{کد ملی}",
    "mobileNumber":"{شماره همراه}"
}'

مرحله دوم: 
curl --location 'https://shabanic.ir/api/v1/repayment_validation_verify_otp_and_token' \
--header 'SHABANIC-API-KEY: {توکن API شبانیک}' \
--header 'Content-Type: application/json' \
--data '{
    "otpCode":"{کد 5 رقمی پیامک شده}",
    "token":"{توکنی که در پاسخ مرحله اول دریافت کرده اید}"
}'

مرحله سوم: بعد از 30 ثانیه درخواست زیر را بفرستید
curl --location 'https://shabanic.ir/api/v1/repayment_validation_get_report_link' \
--header 'SHABANIC-API-KEY: {توکن API شبانیک}' \
--header 'Content-Type: application/json' \
--data '{
    "otpCode":"{کد 5 رقمی پیامک شده}",
    "token":"{توکنی که در پاسخ مرحله اول دریافت کرده اید}"
}'

مرحله چهارم: مجدد سی ثانیه صبر نمایید و درخواست زیررا ارسال نمایید.
curl --location 'https://shabanic.ir/api/v1/repayment_validation_get_final_report_json' \
--header 'SHABANIC-API-KEY: {توکن API شبانیک}' \
--header 'Content-Type: application/json' \
--data '{
    "otpCode":"{کد 5 رقمی پیامک شده}",
    "token":"{توکنی که در پاسخ مرحله اول دریافت کرده اید}"
    "uniqueCode":"{بخش آخر مقدار reportLink را که در مرحله سوم دریافت کرده اید را واردن مایید}"
	
}'

📌 ورودی های سرویس

🗂️ JSON Inputs

مرحله اول:
{
    "nationalCode":"{کد ملی}",
    "mobileNumber":"{شماره همراه}"
}


مرحله دوم:
{
    "otpCode":"{کد 5 رقمی پیامک شده}",
    "token":"{توکنی که در پاسخ مرحله اول دریافت کرده اید}"
}

مرحله سوم:
{
    "otpCode":"{کد 5 رقمی پیامک شده}",
    "token":"{توکنی که در پاسخ مرحله اول دریافت کرده اید}"
}

مرحله چهارم:
{
    "otpCode":"{کد 5 رقمی پیامک شده}",
    "token":"{توکنی که در پاسخ مرحله اول دریافت کرده اید}"
    "uniqueCode":"{بخش آخر مقدار reportLink را که در مرحله سوم دریافت کرده اید را واردن مایید}"
	
}

📤 خروجی سرویس

🧾 JSON Response

مرحله اول:
{
    "statusCode": 200,
    "message": "درخواست با موفقیت انجام شد",
    "isSuccess": true,
    "response": {
        "data": {
            "result": {
                "token": "UHcvZkpPOUN3UVlpZTRmaTNRVzZyUFhITnZaMDY5QXZzQWVnU0JXRVcyaTIwMzVzUDNZSjZYSXcyZkhqWHBKRw=="
            },
            "trackId": "A8thJSzls"
        },
        "message": "service called successfully",
        "isSuccess": true
    }
}


مرحله دوم:
{
    "statusCode": 200,
    "message": "درخواست با موفقیت انجام شد",
    "isSuccess": true,
    "response": {
        "data": {
            "result": {
                "status": "InProcessing"
            },
            "trackId": "o0C_dkk4H"
        },
        "message": "service called successfully",
        "isSuccess": true
    }
}

مرحله سوم:
{
    "statusCode": 200,
    "message": "درخواست با موفقیت انجام شد",
    "isSuccess": true,
    "response": {
        "data": {
            "result": {
                "status": "ساخت گزارش",
                "reportLink": "https://app.ics24.ir/report/pc0OCkLuLURCpXmNt0_8MTMa1Vw7XxWqE0ldVafV3ic=",
                "messageStatusTitle": "null"
            },
            "trackId": "B72BRyszi"
        },
        "message": "service called successfully",
        "isSuccess": true
    }
}

مرحله چهارم:
{
    "statusCode": 200,
    "message": "درخواست با موفقیت انجام شد",
    "isSuccess": true,
    "shabanicShowUrl": "https://shabanic.ir/bank-scoring/NzQ0OTQ0ODg5MDA",
    "pdfDownloadLink": "https://shabanic.ir/repayment_pdf/NzQ0OTQ0ODg5MDA",
    "response": {
        "data": {
            "result": {
                "data": {دیتای اعتبار سنجی}
            },
            "trackId": "lMXH2OO0u"
        },
        "message": "service called successfully",
        "isSuccess": true
    }
}


{
	"success": false,
	"error_code": "FN-BRFH-50000040816",
	"message": "پیغام مرتبط با خطا",
	"trackId": "shabanic-699dcc859daf40.50355751"
}
برای پیگیری خطا کافیست مقدار trackId را به پشتیبانی شبانیک بدهید.

ℹ️ توضیحات سرویس استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی)

این سرویس برای استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی) استفاده می‌شود. در ادامه مشخصات کامل درخواست و پاسخ را مشاهده می‌کنید.

ورودی‌ها (Parameters)

  • nationalCode — مرحله اول - کدملی کاربر
  • mobileNumber — مرحله اول - شماره همراه
  • otpCode — مرحله دوم - کد 5 رقمی پیامک شده
  • token — مرحله دوم - توکنی که در پاسخ مرحله اول دریافت کرده اید
  • otpCode — مرحله سوم - کد 5 رقمی پیامک شده
  • token — مرحله سوم - توکنی که در پاسخ مرحله اول دریافت کرده اید
  • otpCode — مرحله چهارم - کد 5 رقمی پیامک شده
  • token — مرحله چهارم - توکنی که در پاسخ مرحله اول دریافت کرده اید.
  • uniqueCode — مرحله چهارم - بخش آخر مقدار reportLink را که در مرحله سوم دریافت کرده اید را واردن مایید

خروجی‌ها (Response)

  • statusCode — تمام مراحل - کد وضعیت درخواست
  • message — تمام مراحل - پیغام متانسب با ریسپانس برگشت داده شده
  • isSuccess — تمام مراحل - وضعیت موفقیت یا عدم موفقیت درخواست
  • token — مرحله اول - توکن دریافتی برای ارسال در مراحل دیگر
  • status — مرحله دوم - وضعیت درخواست، اگر برابر با InProcessing باشد یعنی درخواست در حال پردازش است
  • status — مرحله سوم - وضعیت درخواست که عموما برابر با عبارت "ساخت گزارش" است
  • reportLink — مرحله سوم - لینک دریافت گزارش، بایستی قسمت پایانی این لینک در مرحله چهارم به عنوان uniqueCode پرامتر ارسال گردد.
  • data — مرحله چهارم - دیتای اعتبار سنجی

کاربرد های این Api

  • دریافت رتبه اعتباری —با هدف ارائه بانک ها و موسسات بانکی این سرویس مورد نیاز می باشد

نکات مهم

  • فعال‌سازی API شبانیک — برای شروع استفاده از APIهای شبانیک، ابتدا پروفایل خود را تکمیل کنید (مشاهده پروفایل) و سپس با پشتیبانی مستقیم شبانیک (09156012679) برای صدور مجوز و دریافت توکن اقدام نمایید.
  • توکن شبانیک — پس از دریافت مجوز، توکن خود را به‌عنوان Bearer در هدر درخواست‌ها قرار دهید.

🎬 ویدئوی آموزشی API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی)

در این ویدئو نحوه فراخوانی API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی) از سامانه شبانیک توضیح داده شده است.

💻 دانلود نمونه کدهای API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی)

در این بخش می‌توانید نمونه کدهای آماده برای فراخوانی API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی) شبانیک به زبان‌های PHP (Laravel)، JavaScript (Node.js)، Python، Java، Kotlin، C# (.NET) و cURL را دانلود کرده و مستقیماً در پروژه خود استفاده کنید.

نمونه کد PHP (Laravel) برای فراخوانی API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی)

دانلود فایل PHP

نمونه کد JavaScript (Node.js) برای استفاده از API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی)

دانلود فایل JavaScript

نمونه کد Python برای اتصال به API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی) شبانیک

دانلود فایل Python

نمونه کد Java (اندروید) برای فراخوانی API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی)

دانلود فایل Java

نمونه کد Kotlin برای استفاده از API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی) در اپلیکیشن موبایل

دانلود فایل Kotlin

نمونه کد C# (.NET) برای اتصال به API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی)

دانلود فایل C#

نمونه درخواست cURL برای تست API استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی)

دانلود فایل cURL
دانلود همه نمونه کدهای API این سرویس به صورت (ZIP)

❓ سوالات متداول (FAQ)

پاسخ به سوالات رایج در استفاده از سرویس استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی).

آماده‌اید به ساده‌ترین شکل ممکن، API «استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی)» را از شبانیک دریافت کنید؟

تنها در چند مرحله ساده، کلید اختصاصی API خود را دریافت کرده و سرویس استعلام رتبه اعتباری بانکی اشخاص حقیقی (اعتبارسنجی بانکی) را در پروژه خود فعال کنید.

رفتن به پنل توسعه‌دهندگان
Shabanic Postman