پرش به مطلب اصلی

ایجاد وام

در یک نگاه​

در این سند توضیح می‌دهیم که چگونه با SDK زربان وام می‌سازید. این SDK رابطی ساده در اختیارتان می‌گذارد تا وام تازه بسازید و وضعیتش را دنبال کنید.

پیش‌نیازها​

  • SDK زربان (zarban.wallet)
  • توکن دسترسی معتبر API
  • اطلاعات کاربر فرزند، اگر لازم داشتید

نصب​

pip install zarban

احراز هویت​

این SDK دو نوع احراز هویت می‌خواهد:

  • توکن دسترسی API
  • هدر کاربر فرزند؛ اختیاری است و به کاربردتان بستگی دارد
cfg = wallet.Configuration(host="https://testwapi.zarban.io")
cfg.access_token = ACCESS_TOKEN
api_client = wallet.ApiClient(cfg)
api_client.default_headers['X-Child-User'] = "your_child_username"

توابع اصلی​

ایجاد وام​

create_loan(api_instance, plan_name, collateral, debt, symbol, loan_to_value_option)​

با پارامترهایی که می‌دهید یک وام تازه می‌سازد.

پارامترها:

  • api_instance : نمونه LoansApi
  • plan_name: str - نام طرح وام (لیست طرح‌های پشتیبانی‌شده را از پاسخ API یا داشبورد به‌روز دریافت کنید)
  • collateral: str - مقدار وثیقه
  • debt: str - مقدار بدهی
  • symbol: str - نماد ارز، برای نمونه USDT
  • loan_to_value_option: str - سطح ریسک ("Safe"، "Normal" یا "Risky")

نکات مهم:

  • یکی از دو فیلد collateral یا debt باید خالی بماند
  • اگر موفق شود شناسه وام را برمی‌گرداند و اگر شکست بخورد None

مثال:

loan_id = create_loan(
    loans_api,
    plan_name="DAIA",
    collateral="1000",
    debt="",
    symbol="USDT",
    loan_to_value_option="Safe"
)

بررسی وضعیت وام​

loan_Status(api_instance, loan_id)​

وضعیت کنونی وام را می‌گیرد و نشان می‌دهد.

پارامترها:

  • api_instance: نمونه LoansApi
  • loan_id: str - شناسه وام برای بررسی

خروجی: شیء جزئیات وام شامل:

  • وضعیت
  • مقدار وثیقه
  • مقدار بدهی
  • نرخ بهره
  • تاریخ ایجاد

مثال:

loan_details = loan_Status(loans_api, loan_id)

نقاط پایانی API​

POST /loans/create​

یک صندوق یا وام تازه می‌سازد.

بدنه درخواست:

{
  "intent": "Create",
  "planName": "DAIA",
  "collateral": "1000",
  "debt": "",
  "symbol": "USDT",
  "loanToValueOption": "Safe"
}

پاسخ (200 OK):

{
  "id": "1234567890"
}

GET /loans/{id}​

جزئیات وام را برمی‌گرداند.

پارامترهای مسیر:

  • id: شناسه وام

پاسخ (200 OK): جزئیات وام را برمی‌گرداند: وضعیت، وثیقه، بدهی و دیگر اطلاعات مرتبط.

مدیریت خطا​

SDK از ApiException برای مدیریت خطا استفاده می‌کند. خطاهای رایج این‌هاست:

  • 400: درخواست نادرست
  • 401: عدم احراز هویت
  • 500: خطای داخلی سرور

مثال مدیریت خطا:

try:
    loan_details = loans_api.get_loan_details(loan_id)
except wallet.ApiException as e:
    print(f"Error: {e}")

مثال کامل استفاده​

def main():
    # Replace with your actual access token
    ACCESS_TOKEN = "your_child_username"

    # Setup API client
    cfg = wallet.Configuration(host="https://testwapi.zarban.io")
    cfg.access_token = ACCESS_TOKEN
    api_client = wallet.ApiClient(cfg)
    loans_api = wallet.LoansApi(api_client)

    # Set the X-Child-User header in the api_client's default headers
    api_client.default_headers['X-Child-User'] = "your_child_username"
    # Create loan
    loan_id = create_loan(
        loans_api,
        "DAIA",    # plan name
        "1000",    # collateral
        "",        # debt
        "USDT",    # symbol
        "Safe"     # loan to value option
    )

    # Check status
    if loan_id:
        loan_details = loan_status(loans_api, loan_id)

نکات مهم​

  • هدر X-Child-User را پس از استفاده همیشه حذف کنید:
api_client.default_headers.pop('X-Child-User', None)
  • برای همه فراخوانی‌های API خطاها را درست مدیریت کنید
  • پارامترهای ورودی را پیش از فراخوانی API اعتبارسنجی کنید
  • اطلاعات حساس مانند توکن دسترسی را در متغیرهای محیطی نگه دارید

محدودیت‌ها​

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

پشتیبانی​

برای پشتیبانی بیشتر یا گزارش اشکال، با تیم پشتیبانی زربان تماس بگیرید.

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