مستندات API تطبیق شماره شبا با کد ملی

مستندات API تطبیق شماره شبا با کد ملی | راهنمای کامل استفاده

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

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

این وب سرویس کد ملی و شماره شبا شخص را براساس اطلاعات ثبت شده بررسی و صحت آن‌ها را تأیید می‌کند

🏷️ CURL

📡 POST api/v2/matchIbanByNationalcode

curl --location 'https://shabanic.ir/api/v2/matchIbanByNationalcode' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_SHABANIC_TOKEN}' \
--data '{
  "iban": "IR040170000000******195000",
  "nationalCode": "082****049"
}'

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

🗂️ JSON Inputs

{
    "nationalCode": "082xxxx049",
    "iban": "IR04017000000034xxxx195000"
}

📤 خروجی سرویس

🧾 JSON Response

{
    "success": true,
    "trackId": "shabanic-69d10620952450.81360863",
    "message": null,
    "result": {
        "isMatched": true
    },
    "statusCode": 200
}

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

ℹ️ توضیحات سرویس تطبیق شماره شبا با کد ملی

این سرویس برای تطبیق شماره شبا با کد ملی استفاده می‌شود. در ادامه مشخصات کامل درخواست و پاسخ را مشاهده می‌کنید.

ورودی‌ها (Parameters)

  • nationalCode — کد ملی کاربر
  • iban — شماره شبای کاربر

خروجی‌ها (Response)

  • success — نشان‌دهنده موفق بودن اجرای درخواست
  • status — وضعیت نهایی پردازش سرویس (DONE یعنی تکمیل شده)
  • trackId — شناسه یکتای پیگیری تراکنش در سامانه شبانیک
  • isMatched — نتیجه اعتبارسنجی؛ true یعنی اطلاعات معتبر است

کاربرد های این 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

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

پاسخ به سوالات رایج در استفاده از سرویس تطبیق شماره شبا با کد ملی.

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

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

برای استفاده باید یک درخواست POST به endpoint /api/v2/ibanOwnerVerification ارسال کنید، در هدر درخواست توکن Bearer Token شبانیک را قرار دهید و در بدنه JSON، فیلدهای iban و nid را ارسال کنید تا پاسخ اعتبارسنجی دریافت شود.

در ورودی JSON باید دو فیلد ارسال شود: { "iban": "شماره شبا", "nid": "کد ملی" } خروجی JSON شامل وضعیت success، status، trackId و نتیجه اعتبارسنجی در فیلد isValid خواهد بود که اگر مقدار آن yes باشد، اعتبارسنجی موفق بوده است.

پاسخ API شامل این موارد است: ✔️ success (موفق یا ناموفق بودن درخواست) ✔️ status (وضعیت پردازش مثل DONE) ✔️ trackId (شناسه یکتا برای پیگیری تراکنش) ✔️ result.isValid (نتیجه اعتبارسنجی شبا با کد ملی)

توکن شبانیک کلید احراز هویت API است که بعد از ثبت‌نام در شبانیک دریافت می‌کنید. این توکن باید در هدر درخواست شما به صورت Authorization: Bearer {YOUR_SHABANIC_TOKEN} قرار گیرد تا API اجازه پردازش به شما دهد.

اگر شماره شبا دارای فرمت اشتباه یا غیر معتبر باشد، API مقدار result.isValid را no برمی‌گرداند و می‌توانید براساس آن در اپلیکیشن یا سایت پیام خطای مناسب به کاربر نمایش دهید.

بله، می‌توانید با استفاده از توکن شبانیک در محیط توسعه نیز آن را فراخوانی کنید. برای تست بهتر است از شماره شبا و کد ملی تستی یا موارد نمونه در مستندات شبانیک استفاده کنید.

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

اعتبارسنجی شبا با کد ملی باعث می‌شود تا: ✔️ اطلاعات بانکی کاربران واقعی‌تر شوند ✔️ از خطاهای پرداخت و انتقال پول اشتباه جلوگیری شود ✔️ سیستم‌های مالی و بانکی امنیت بیشتری داشته باشند ✔️ در فرایندهای احراز هویت دیجیتال، اعتماد بیشتری ایجاد گردد

آماده‌اید به ساده‌ترین شکل ممکن، API «تطبیق شماره شبا با کد ملی» را از شبانیک دریافت کنید؟

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