⚠

کدام API؟ این بخش، کیت توسعه نرم‌افزار کیف پول زربان است — احراز هویت با رایانامه و گذرواژه کاربر نهایی.

اگر با زربان قرارداد سازمانی دارید و clientId گرفته‌اید، مستندات شما این نیست؛ به یکپارچه‌سازی سازمانی بروید.

ثبت‌نام کاربر

در این مثال می‌بینید که چگونه با SDK زربان ثبت‌نام کاربر را پیاده می‌کنید: درخواست ثبت‌نام را به API زربان می‌فرستید و حساب کاربری تازه‌ای می‌سازید.

پیش‌نیازها

پیش از اجرای این مثال، مطمئن شوید که:

1. SDK زربان را نصب کرده‌اید:

   pip install zarban

2. به API زربان در محیط تست دسترسی دارید

نمونه کد

import zarban.wallet.openapi_client as wallet

def signup_example():
    # Create and configure the Configuration object
    cfg = wallet.Configuration(
        host="https://testwapi.zarban.io"
    )

    # Create an instance of the ApiClient with the configuration
    api_client = wallet.ApiClient(configuration=cfg)

    # Create an instance of the AuthApi using the api_client
    auth_api = wallet.AuthApi(api_client)

    # Prepare the signup request data
    signup_request = wallet.SignUpRequest(
        email="user@example.com",
        password="yourSecuredPassword",
    )

    try:
        # Call the signup API
        api_response = auth_api.signup_with_email_and_password(signup_request)
        print("Confirmation link sent successfully!")
        print(f"Message: {api_response.messages}")

    except wallet.ApiException as e:
        print(f"Exception when calling auth_api->signup_with_email_and_password: {e}")
        print(f"Error message: {e.body}")

if __name__ == "__main__":
    signup_example()

توضیح گام به گام ثبت نام کاربر

۱. وارد کردن ماژول‌های مورد نیاز

import zarban.wallet.openapi_client as wallet

این import‌ها کلاس‌ها و توابع لازم برای تعامل با API زربان را فراهم می‌کنند.

۲. پیکربندی API Client

cfg = wallet.Configuration(host="https://testwapi.zarban.io")
api_client = wallet.ApiClient(configuration=cfg)

یک شیء پیکربندی با نقطه پایانی API ایجاد می‌کند و کلاینت API را راه‌اندازی می‌کند.

۳. راه‌اندازی نمونه API

auth_api = wallet.AuthApi(api_client)

با کلاینتی که پیکربندی کرده‌اید، یک نمونه از کلاس AuthApi می‌سازد.

۴. آماده‌سازی درخواست ثبت‌نام

signup_request = wallet.SignUpRequest(
    email="user@example.com",
    password="yourSecuredPassword",
)

یک شیء درخواست ثبت‌نام با اطلاعات کاربر ایجاد می‌کند.

۵. ارسال درخواست API

api_response = auth_api.signup_with_email_and_password(signup_request)

درخواست ثبت‌نام را به API ارسال می‌کند و پاسخ را مدیریت می‌کند.

مدیریت پاسخ

این مثال شامل مدیریت خطا با استفاده ازبلوک‌های try/catch است:

• اگر موفق شود: پیام تأیید و پیام‌های پاسخ را چاپ می‌کند
• اگر شکست بخورد: جزئیات خطا را چاپ می‌کند

خروجی مورد انتظار

در صورت ثبت‌نام موفق:

Confirmation link sent successful!
Message: [Confirmation email details...]

در صورت خطا:

Exception when calling DefaultApi->auth_signup_post: [Error details]
Error message: [Detailed error message]

نکات مهم

• به‌جای "user@example.com" و "yourSecuredPassword" اطلاعات کاربری واقعی بگذارید
• این مثال از نقطه پایانی تستِ API امانی (testwapi.zarban.io) استفاده می‌کند؛ برای محیط تولید، host را به https://api.zarban.io تغییر دهید. عملیاتِ روی زنجیره (زرگری و صندوق‌ها) نقطه پایانی تست دیگری (testapi.zarban.io) دارد
• در محیط تولید، حتماً شیوه‌های امنیتی مناسب را برای گذرواژه رعایت کنید
• API یک ایمیل تأیید به آدرس ایمیل ارائه‌شده ارسال خواهد کرد

مدیریت خطاها

خطاهای رایج که ممکن است رخ دهند:

• فرمت نامعتبر ایمیل
• رمز عبور الزامات امنیتی را برآورده نمی‌کند
• این نشانی رایانامه پیش‌تر ثبت شده است
• اتصال شبکه مشکل دارد
• سرور API خطا داده است

بیشتر بخوانید

• مستندات مرجع API
• نکات مهم امنیتی