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

ایجاد وام

نمای کلی​

این سند نحوه استفاده از SDK زربان برای ایجاد وام‌ها را توضیح می‌دهد. این SDK قابلیت‌هایی برای ایجاد وام‌های جدید و نظارت بر وضعیت آنها از طریق یک رابط ساده فراهم می‌کند.

پیش‌نیازها​

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

نصب​

pip install zarban

احراز هویت​

SDK نیاز به دو نوع احراز هویت دارد:

  • توکن دسترسی API
  • هدر کاربر فرزند (اختیاری، بسته به مورد استفاده)
configuration = Configuration(host="https://testwapi.zarban.io")
configuration.access_token = "your_access_token_here"
api_client = ApiClient(configuration)
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: نمونه DefaultApi
  • plan_name: str - نام طرح وام (در حال حاضر "DAIA" و "DAIB" پشتیبانی می‌شود)
  • collateral: str - مقدار وثیقه
  • debt: str - مقدار بدهی
  • symbol: str - نماد ارز (مثلاً "USDT")
  • loan_to_value_option: str - سطح ریسک ("Safe"، "Normal" یا "Risky")

نکات مهم:

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

مثال:

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

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

loan_Status(api_instance, loan_id)​

وضعیت فعلی وام را دریافت و نمایش می‌دهد.

پارامترها:

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

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

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

مثال:

loan_details = loan_Status(api_instance, 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 برای مدیریت خطا استفاده می‌کند. خطاهای رایج عبارتند از:

  • ۴۰۰: درخواست نادرست
  • ۴۰۱: عدم احراز هویت
  • ۵۰۰: خطای داخلی سرور

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

try:
    loan_details = api_instance.loans_id_get(loan_id)
except ApiException as e:
    print(f"Error: {e}")

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

def main(): # Setup
ACCESS_TOKEN = "your_access_token_here"
configuration = Configuration(host="https://testwapi.zarban.io")
configuration.access_token = ACCESS_TOKEN
api_client = ApiClient(configuration)
api_instance = DefaultApi(api_client)
    # Set child user header
    api_client.default_headers['X-Child-User'] = "your_child_username"
    # Create loan
    loan_id = create_loan(
        api_instance,
        "DAIA",    # plan name
        "1000",    # collateral
        "",        # debt
        "USDT",    # symbol
        "Safe"     # loan to value option
    )
    # Check status
    if loan_id:
        loan_details = loan_Status(api_instance, loan_id)

نکات مهم​

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

محدودیت‌ها​

  • در حال حاضر فقط طرح‌های "DAIA" و "DAIB" پشتیبانی می‌شوند
  • هنگام ایجاد وام، یا وثیقه یا بدهی باید خالی باشد
  • توکن‌های دسترسی API باید امن نگهداری شوند و نباید به صورت هاردکد شده باشند

پشتیبانی​

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

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