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

این مثال نحوه استفاده از SDK زربان برای پیاده‌سازی فرآیند ثبت‌نام کاربر را نشان می‌دهد. این مثال نحوه ایجاد یک حساب کاربری جدید را با ارسال درخواست ثبت‌نام به API زربان نمایش می‌دهد.

پیش‌نیازها

قبل از اجرای این مثال، اطمینان حاصل کنید که:

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

pip install zarban

۲. به 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="[email protected]",
        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="[email protected]",
    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]

نکات مهم

• "[email protected]" و "yourSecuredPassword" را با اطلاعات کاربری واقعی جایگزین کنید
• این مثال از نقطه پایانی API تست (testwapi.zarban.io) استفاده می‌کند. برای استفاده در محیط تولید، host را متناسباً به‌روزرسانی کنید
• اطمینان حاصل کنید که در محیط تولید، شیوه‌های امنیتی مناسب برای رمز عبور رعایت می‌شود
• API یک ایمیل تأیید به آدرس ایمیل ارائه شده ارسال خواهد کرد

مدیریت خطاها

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

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

همچنین ببینید

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