آخرین تغییرات: ۱۴۰۰/۰۹/۱۰

کسب و کار

مقدمه

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

نکته! همواره به جای {business} نام انگلیسی کسب‌وکار جایگذاری شود.

اطلاعات

در این بخش اطلاعات مربوط به کسب و کار خاصی نمایش داده میشود نکته: به جای {business} نام کسب‌وکار ثبت شده خود در وندار را بنویسید.

METHOD: GET
URL: https://api.vandar.io/v2/business/{business}

نمونه پاسخ دریافتی موفق 

HTTP/1.1 200
{
 "status": 1,
    "data": [
            "id": 662,
            "active": 1,
            "business_name": "your business name",
            "business_name_fa": "مریم",
            "legal_business_name": null,
            "national_id":null,
            "business_type": "personal",
            "phone_number": "88****22",
            "postal_code": "0123456789",
            "city_id":"8-6",
            "mcc_code": "15200002",
            "address": "تهران میدان آزادی",
            "wallet": 1050,
            "deductible_amount": "10500",
            "blocked_amount": 0,
            "avatar": "businesses/avatars/iz3giCpBWyoj7CYoalqulFX3RyQ63CMkbxFvQ5Zn.png",
            "statusBox": {
                "payment_required": false,
                "national_card_photo":"accepted",
                "official_Newspaper": "accepted",
                "introduction_letter": "accepted"
            },
            "status": 1,
            "today_transactions": 0,
            "today_settlements": 0,
            "role_name": "مالک",
            "role": "owner",
            "permissions": [
                "business_setting",
                "add_iban",
                "remove_iban",
                "view_dashboard",
                "create_request_forms",
                "view_gateway_ipgs",
                "create_gateway_ipgs",
                "edit_gateway_ipgs",
                "view_transactions_report",
                "view_settlements",
                "add_settlements",
                "edit_settlements",
                "view_request_forms"
            ],
            "tools": {
                "ipg": {
                    "is_enabled":true,
                    "is_created": true
                },
                "subscription": {
                    "is_enabled": false,
                    "is_created": null
                },
                "requestMoney": {
                    "is_enabled": true,
                    "is_created": false
                },
                "api": {
                    "is_enabled": false,
                    "is_created": null
                },
                "customer": {
                    "is_enabled": false,
                    "is_created": null
                },
                "log": {
                    "is_enabled": true
                    "is_created": null
                }
            }

]

}
  • نمونه خروجی مشابه خروجی لیست تمامی کسب و کار ها است .

نمونه پاسخ دریافتی ناموفق 

HTTP/1.1 401
{
    "status": 0,
    "error": Unauthenticated
}
  • status: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
  • error: نوع خطا را نمایش میدهد

کاربران

در این بخش میتوانید تمامی کاربران کسب و کار خود را مشاهده کنید با نمایش نقش آن ها و مواردی دیگر که در زیر توضیح داده میشود . نکته: به جای {business} نام کسب‌وکار ثبت شده خود در وندار را بنویسید

METHOD: GET
URL: https://api.vandar.io/v2/business/{business}/iam?page=1&per_page=10

نمونه پاسخ دریافتی موفق 

HTTP/1.1 200
{


    "status": 1,
    "data": {
      "users": [
        {
          "name": "مریم نبیان",
          "avatar": "https://vandar.io/storage/users/default.png",
          "role, "مالک کسب و کار":
          "status": 1,
          "role_id": 0,
          "id": null
        }
      ]
    }
}
  • status: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
  • data: شامل لیست کاربران و اطلاعات آن ها می باشد
    • name : نام کاربر در کسب و کار است .
    • avatar : عکس کاربر در کسب و کار است .
    • role : نقش کاربر در کسب و کار را میگوید.
    • status : مقدار 0 و 1 دارد که نشان دهنده فعال یا غیر فعال بودن کاربر است.
    • role_id : ایدی مورد نظر با نقش کاربر را میگوید.
      • 0 : مالک کسب و کار
      • 1 : مدیر
      • 2 : حسابدار
      • 3 : برنامه نویس
      • 4 : ناظر
    • id : ایدی فرد در کسب و کار میباشد

نمونه پاسخ دریافتی ناموفق 

HTTP/1.1 401
{
    "status": 0,
    "error": Unauthenticated
}
  • status: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
  • error: نوع خطا را نمایش میدهد