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

دریافت موجودی باقی‌مانده (Get Info)

می‌توان اطلاعات حساب کاربری، از جمله موجودی فعلی حساب را مشاهده کرد.

اطلاعات عمومی​

  • آدرس: https://corporate.snapp.site/api/v3/profile/info
  • متد: GET
  • نوع محتوا: application/json
  • احراز هویت: نیازمند token

احراز هویت​

  • این درخواست نیاز به یک Authorization token دارد که باید در هدر ارسال شود.

نمونه درخواست​

curl --location 'https://corporate.snapp.site/api/v3/profile/info' \
--header 'Authorization: <your_authorization_token>' \
--header 'Content-Type: application/json'

پاسخ موفق​

{
    "message": "Success",
    "data": {
        "email": "saman.farajzadeh.test@snapp.cab",
        "fullname": "saman",
        "phone": "02199999999",
        "cellphone": "+989111002233",
        "photo_url": "https://www.gravatar.com/avatar/df35359ae16a56a2b48f5019867b5a03?s=200",
        "credit": 935310000,
        "credit_threshold": 10000000,
        "default_credit_threshold": 10000000,
        "totp_status": 0
    },
    "status": 200
}

توضیحات فیلدهای پاسخ​

اطلاعات پروفایل (data)​

فیلدنوع دادهتوضیحات
emailstringایمیل کاربر
fullnamestringنام کامل کاربر
phonestringشماره تلفن ثابت کاربر
cellphonestringشماره تلفن همراه کاربر
photo_urlstringURL عکس پروفایل کاربر
creditintegerاعتبار کاربر
credit_thresholdintegerآستانه اعتبار کاربر
default_credit_thresholdintegerآستانه اعتبار پیش‌فرض کاربر
totp_statusintegerوضعیت TOTP (احراز هویت دو مرحله‌ای مبتنی بر زمان) کاربر (0: غیرفعال)

اطلاعات کلی پاسخ​

فیلدنوع دادهتوضیحات
messagestringپیام کلی پاسخ (مثلاً "Success")
statusintegerکد وضعیت پاسخ (200 برای موفقیت)

خطاها​

(اطلاعات مربوط به خطاها در پاسخ ارائه شده مشخص نشده است، اما ممکن است شامل موارد زیر باشد:)

کد وضعیتتوضیحات
401نیاز به احراز هویت
403دسترسی غیرمجاز
500خطای داخلی سرور

توضیحات تکمیلی​

  • این API برای دریافت اطلاعات پروفایل کاربر استفاده می‌شود.
  • درخواست باید با توکن JWT احراز هویت شود.
  • پاسخ JSON شامل اطلاعات پروفایل کاربر و وضعیت کلی پاسخ است.
  • در صورت موفقیت، کد وضعیت 200 و پیام "Success" برگردانده می‌شود.