نحوه اتصال به درگاه بانک ملی (BMI) با استفاده از فریمورک جنگو

همان طور که میدانید امروزه تمامی سایت های اینترنتی برای دریافت وجه از کاربر خود از یک درگاه پرداخت اینترنتی استفاده میکنند. درگاه پرداخت اینترنتی امکان پرداخت آنلاین وجوه مشتریان وبسایت‌های فروشگاهی عرضه‌کننده کالا و خدمات را فراهم می‌کند. مشتری پس از تکمیل مراحل انتخاب محصول یا خدمت مورد نظر، در مرحله آخر وارد درگاه پرداخت اینترنتی شده و با وارد کردن اطلاعات کارت بانکی خود شامل شماره کارت، رمز دوم، تاریخ انقضا و کد اعتبارسنجی (CVV2) پرداخت خود را به آسانی انجام می‌دهد.

اینجاست که اهمیت داشتن یک درگاه پرداخت خوب برای وب سایت به خوبی احساس میشود. برای داشتن یک درگاه اینترنتی میتوانید از درگاه های مختلفی در وب سایت خود نظیر درگاه های بانک ملی، بانک ملت، درگاه پرداخت IDPAY، زیبال، زرین پال و ... استفاده کنید؛ اما سوال اینجاست که چگونه میتوان چنین سیستمی را در وبسایت خود پیاده سازی کرد.

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

ساخت یک وب سرویس بانک ملی

قبل از انجام هر کاری نیاز به ساخت یک وب سرویس در خود وبسایت بانک ملی دارید. برای این منظور میتوانید به آدرس زیر مراجه کنید.

درگاه پرداخت بانک ملی ایران(BMI)

نصب پکیج

خب حالا برای ادامه کار لازم است پکیج زیر را نصب کنید.

pip install az-iranian-bank-gateways

settings.py

بعد از نصب پکیج بالا تنظیمات زیر را در فایل settings.py پروژه خود انجام دهید.

INSTALLED_APPS = [
   # ....
   'azbankgateways',
   # ...
]

AZ_IRANIAN_BANK_GATEWAYS = {
   'GATEWAYS': {
       'BMI': {
           'MERCHANT_CODE': '<YOUR MERCHANT CODE>',
           'TERMINAL_CODE': '<YOUR TERMINAL CODE>',
           'SECRET_KEY': '<YOUR SECRET CODE>',
       },
   },
   'DEFAULT': 'BMI',
   'CURRENCY': 'IRR', # اختیاری
   'TRACKING_CODE_QUERY_PARAM': 'tc', # اختیاری
   'TRACKING_CODE_LENGTH': 16, # اختیاری
   'SETTING_VALUE_READER_CLASS': 'azbankgateways.readers.DefaultReader', # اختیاری
   'BANK_PRIORITIES': [
       'BMI',
       # and so on ...
   ], # اختیاری
}

1. GATEWAYS : تنظیمات مربوط به هر بانک به صورت دیکشنری های جدا در این قسمت وجود دارد. تنظیماتی مانند کلاس اجرا کننده، کلیدهای امنیتی که توسط بانک در اختیار شما قرار می گیرد.
2. DEFAULT: در زمانی که به سازنده فکتوری پارامتری ارسال نشود از این تنظیم به عنوان بانک پیش فرض استفاده خواهد شد و ارتباطات با این بانک برقرار می شود.
3. CURRENCY - (IRR, IRT): واحد پولی که نرم افزار با آن کار می کند. این واحد پولی فارغ از واحد پولی درگاه خواهد بود. در صورتی که واحد پولی نرم افزار با واحد پولی درگاه بانک متفاوت باشد تبدیل ریال به تومان یا بالعکس انجام خواهد شد.
4. TRACKING_CODE_QUERY_PARAM : پارامتری که در هنگام بازگشت از درگاه به کال بک یو آر ال تعیین شده تنظیم و ارسال می گردد. به عنوان مثال زمانی که از کاربر از درگاه بانک باز می گردد چه پرداخت موفق داشته باشد و چه نا موفق کاربر به لینکی که در هنگام استفاده از درگاه تنظیم شده است٬ ارجاع داده می شود و در انتهای آن این رشته + کد پیگیری بازگردانده می شود تا بتوان داده ها را از این طریق بازیابی کرد.
5. TRACKING_CODE_LENGTH: طول کد پیگیری تولید شده توسط سیستم است. دقت شود که در برخی درگاه ها مانند درگاه بانک ملی ایران، طول ۲۰ کاراکتر خطای شماره سفارش ارسال نشده است را می دهد.
6. SETTING_VALUE_READER_CLASS: با مقدار دهی به این تنظیم شما می توانید حالت یک متغیر خوان اضافه کنید که قابلیت های دیگری مثل پروایدر و پشتیبانی از یک بانک با چند اکانت و ... را به آن اضافه کنید.
7. BANK_PRIORITIES: این آرایه اختیاری است. زمانی که وضعیت اتصال به درگاه به صورت خودکار تعیین شده باشد، ابتدا به بانک پیش فرض متصل می شود و سپس بر این اساس شروع به اتصال خواهد کرد، تا به اولین درگاه فعال برسد. در حالت پیش فرض این آرایه خالی است که بعد از اتصال به درگاه مورد نظر در صورت خطا بقیه درگاه ها امتحان نخواهند شد.

urls.py

بعد از settings.py نوبت به فایل urls.py میرسد. پس، تنظیمات زیر را به فایل urls.py پروژه خود اضافه کنید.

from django.contrib import admin
from django.urls import path

from azbankgateways.urls import az_bank_gateways_urls

admin.autodiscover()

urlpatterns = [
    path('admin/', admin.site.urls),
    path('bankgateways/', az_bank_gateways_urls()),
]

با اضافه کردن آدرس بالا به لیست یو آر ال ها، پرداخت ها پس از درگاه به این مسیر هدایت و اعتبار سنجی می شوند و سپس مجدد به سمت کال بکی که به ازای هر درخواست تنظیم می شود، مسیر یابی خواهد شد.

migrate

حالا نیاز است پروژه خود را با استفاده از دستور زیر migrate کنید.

python manage.py migrate

اگر از reverse proxy و https استفاده می کنید برای رفع موارد احتمالی حتما تنظیمات این [لینک](https://stackoverflow.com/questions/62047354/build-absolute-uri-with-https-behind-reverse-proxy/65934202#65934202) انجام دهید.

views.py

برای استفاده و اتصال به درگاه بانک کافی است یک `BankFactory` ایجاد کنیم و پارامترهای اجباری را تنظیم کنیم. سپس کاربر را می توانیم به درگاه بانک هدایت کنیم.

در فایل view.py نیز ویو زیر را به ویوهای خود اضافه نمایید.

from django.urls import reverse
from azbankgateways import bankfactories, models as bank_models, default_settings as settings



def go_to_gateway_view(request):
    # خواندن مبلغ از هر جایی که مد نظر است
    amount = 1000
    # تنظیم شماره موبایل کاربر از هر جایی که مد نظر است
    user_mobile_number = '+989112221234'  # اختیاری

    factory = bankfactories.BankFactory()
    bank = factory.create() # or factory.create(bank_models.BankType.BMI) or set identifier
    bank.set_request(request)
    bank.set_amount(amount)
    # یو آر ال بازگشت به نرم افزار برای ادامه فرآیند
    bank.set_client_callback_url(reverse('callback-gateway'))
    bank.set_mobile_number(user_mobile_number)  # اختیاری

    # در صورت تمایل اتصال این رکورد به رکورد فاکتور یا هر چیزی که بعدا بتوانید ارتباط بین محصول یا خدمات را با این
    # پرداخت برقرار کنید. 
    bank_record = bank.ready()
    
    # هدایت کاربر به درگاه بانک
    return bank.redirect_gateway()

در صورتیکه تمایل دارید به صورت خودکار به اولین درگاه در دسترس متصل شوید. ابتدا از قسمت تنظیمات در بخش `BANK_PRIORITIES ` اولویت های بانک های مد نظر را وارید کنید. سپس به جای استفاده از متد `factory.create` از متد ‍`factory.auto_create` در این بخش استفاده کنید. به متد auto_create می توانید مبلغ مد نظر را نیز برای صحت سنجی از حداقل مبلغ نیز ارسال کنید.

set_mobile_number متدی است که پارامتر شماره موبایل کاربری که قصد خرید دارد را به آن پاس میدهیم. این شماره موبایل جهت پرداخت و پیگیری آسان تر به درگاه ارسال می شود

میتوانید وجه موردنظر را از دیتابیس دریافت کرده و به amount پاس دهید و به درگاه پرداخت بفرستید:)

بازگشت از بانک

وضعیت رکورد بانک به شرح ذیل می باشد.

1. WAITING: در انتظار برای انتقال کاربر به درگاه بانک
2. REDIRECT_TO_BANK: کاربر به درگاه بانک منتقل شده است ولی هنوز از درگاه باز نگشته است.
3. RETURN_FROM_BANK: کاربر از درگاه برگشته ولی عملیات صحت سنجی٬ یا تکمیل نشده است یا با خطا درهنگام تایید از سوی بانک مواجه شده است. در این شرایط می توان با فراخوانی مجدد در بازه زمانی کمتر از ۱۵ دقیقه که کاربر بازگشته است٬ عملیات تایید را مجدد درخواست کرد. شرح تایید مجدد در پایین تر آورده شده است.
4. CANCEL_BY_USER: پرداخت توسط کاربر کنسل شده است.
5. EXPIRE_GATEWAY_TOKEN: ارتباط با درگاه بانک برقرار شده ولی کاربر به درگاه هدایت نشده است.
6. EXPIRE_VERIFY_PAYMENT: در بازه زمانی ۱۵ دقیقه پس از بازگشت٬ موفق به تایید اطلاعات پرداخت نشده ایم.
7. COMPLETE: وضعیت پرداخت موفق است.

برای این منظور ویو زیر را به ویوهای خود در views.py اضافه کنید.

import logging

from django.http import HttpResponse, Http404
from django.urls import reverse

from azbankgateways import bankfactories, models as bank_models, default_settings as settings


def callback_gateway_view(request):
    tracking_code = request.GET.get(settings.TRACKING_CODE_QUERY_PARAM, None)
    if not tracking_code:
        logging.debug(&quotاین لینک معتبر نیست.&quot)
        raise Http404

    try:
        bank_record = bank_models.Bank.objects.get(tracking_code=tracking_code)
    except bank_models.Bank.DoesNotExist:
        logging.debug(&quotاین لینک معتبر نیست.&quot)
        raise Http404

    # در این قسمت باید از طریق داده هایی که در بانک رکورد وجود دارد، رکورد متناظر یا هر اقدام مقتضی دیگر را انجام دهیم
    if bank_record.is_success:
        # پرداخت با موفقیت انجام پذیرفته است و بانک تایید کرده است.
        # می توانید کاربر را به صفحه نتیجه هدایت کنید یا نتیجه را نمایش دهید.
        return HttpResponse(&quotپرداخت با موفقیت انجام شد.&quot)

    # پرداخت موفق نبوده است. اگر پول کم شده است ظرف مدت ۴۸ ساعت پول به حساب شما بازخواهد گشت.
    return HttpResponse(&quotپرداخت با شکست مواجه شده است. اگر پول کم شده است ظرف مدت ۴۸ ساعت پول به حساب شما بازخواهد گشت.&quot)

درخواست تایید مجدد از بانک

import logging
from azbankgateways import bankfactories, models as bank_models, default_settings as settings

factory = bankfactories.BankFactory()

# غیر فعال کردن رکورد های قدیمی
bank_models.Bank.objects.update_expire_records()

# مشخص کردن رکوردهایی که باید تعیین وضعیت شوند
for item in bank_models.Bank.objects.filter_return_from_bank():
	bank = factory.create(bank_type=item.bank_type, identifier=item.bank_choose_identifier)
	bank.verify(item.tracking_code)		
	bank_record = bank_models.Bank.objects.get(tracking_code=item.tracking_code)
	if bank_record.is_success:
		logging.debug(&quotThis record is verify now.&quot, extra={'pk': bank_record.pk})

آدرس پروژه

اینم از اتصال درگاه بانک ملی با فریمورک جنگو؛ امیدوارم براتون مفید بوده باشه و خوشتون بیاد.

موفق باشید و همیشه بدرخشید..