آخرین تغییرات: ۱۳۹۹/۰۷/۱۶

کسب و کار

مقدمه

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

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

لیست کسب و کار ها

با استفاده از این بخش میتوانید لیست تمامی کسب و کارهایتان با جزئیات مورد نیاز را مشاهده کنید.

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

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

HTTP/1.1 200
{

    "status": 1,
    "data": [
        {
            "id":null,
            "business_name":"personal",
            "business_name_fa,"حساب شخصی":"
            "national_code": "00******35",
            "business_type": "personal",
            "phone_number":null,
            "postal_code": <"0123456789">,
            "address":null,
            "wallet": 0,
            "avatar": "users/default.png",
            "city_id": null,
            "mcc_code": null,
            "national_id": null,
            "legal_business_name":null,
            "today_transactions":0,
            "today_settlements": 0,
            "statusBox": {
                "kyc": true,
                "shahkar": false,
                "mobile": "accepted",
                "email": "accepted",
                "personal_information":"accepted",
                "mobile_owner_national_card": false
            }
        },
        {
            "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
                }
            }
        }
    ]
}

                            
  • status: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
  • data: شامل لیست تمامی کسب و کار ها و همچنین حساب شخصی می باشد
    • id : ایدی اختصاصی کسب و کار را نشان میدهد( حساب شخصی دارای ایدی اختصاصی نمیباشد ).
    • active :بیانگر این است که ایا کسب و کار شما فعال است یا خیر (که شامل حساب شخصی نمی شود ).
    • business_name : نام انگلیسی کسب و کار است
    • business_name_farsi : نام فارسی کسب و کار است
    • legal_business_name : (در صورتی که کسب و کار شما از نوع حقوقی باشد در غیر این صورت مقدار null را شامل میشود ).نام حقوقی کسب و کار است
    • national_code :کد ملی فرد میباشد که تنها حشاب شخصی دارای این فیلد است
    • national_id :شناسه ملی کسب و کار است که تنها حساب های حقوقی دارای این شناسه میباشند و دیگر حساب ها مقدار آن null است.
    • business_type :بیانگر نوع حساب است اگر personal باشد به معنای حقیقی است و اگر legal باشد به معنای حقوقی است.
    • phone_number : شماره تلفن حساب شخصی یا کسب و کار شما است
    • postal_code : کد پستی مربوط به نشانه ادرس شما است
    • city_id : کد مربوطه شهر محل سکونت شما است
    • mcc_code : کد مربوط به فعالیت کسب و کار شما است
    • address : آدرس محل سکونت یا شرکت شما است
    • wallet : نماینگر مبلغ کیف پول شما در وندار است
    • deductible_amount : )تنها مربوط به کسب وکار است ). مقدار مبلغی که شما در روز میتوانید تسویه بزنید
    • blocked_amount : مبلغی که توسط پلیس فتا و یا ... بلاک شده است(تنها مربوط به کسب و کار است ).
    • avatar :عکس مربوط به حساب شخصی شما یا لوگو کسب و کار شما است
    • today_transactions : تعداد تراکنش های انجام شده در روز است .
    • today_settlements : مقدار مبلغ تسویه شده در روز را نشان میدهد(مربوط به کسب و کار شما ).
    • status_Box )حساب شخصی (:
      • Kyc :شامل سه مقدار true, false ,null میباشد که به ترتیب بیانگر درست بودن اطلاعات هویتی، غلط بودن اطلاعات هویتی و یا در دست بررسی است
      • Shahkar : شامل سه مقدار true, false ,null میباشد که به ترتیب بیانگر تطابق داشتن شماره موبایل و کارت ملی ، عدم تطابق و یا در دست بررسی بودن است
      • mobile : شامل دو مقدار add, accepted است که در مورد اول باید شماره موبایل خود را در اطلاعات شخصی خود وارد کنید و اگر مورد دوم باشد یعنی شماره موبایل وارد شده صحیح میباشد.
      • email :شامل دو مقدار add, accepted است که در مورد اول باید ایمیل خود را در از طریق ایمیل ارسال شده تایید کنید و اگر مورد دوم باشد یعنی ایمیل شما تایید شده است .
      • personal_information : شامل دو مقدار add, accepted است که در مورد اول باید اطلاعات شخصی خود را دربه صورت صحیح در اطلاعات شخصی خود وارد کنید و اگر مورد دوم باشد یعنی اطلاعات شخصی شما صحیحی است. .
      • mobile_owner_national_card : این فیلد با فیلد shahkar یکی است
    • status_Box )حساب کسب و کار (:
      • payment_required :شامل دو مقدار true, false است که اگر اولی باشد یعنی نیاز به پرداخت برای تایید کسب و کار خود هستید در غیر این صورت خیر
      • national_card_photo : شامل دو مقدار add, accepted است که در مورد اول باید عکس کارت ملی مدیر کسب و کار ارسال شود و اگر مورد دوم باشد یعنی اطلاعات ارسال شده و تایید شده است )مربوط به کسب و کار حقوقی (.
      • official_NewsPaper : شامل دو مقدار add, accepted است که در مورد اول باید عکس روزنامه رسمی کسب و کار خود را ارسال کنید و اگر مورد دوم باشد یعنی عکس روزنامه رسمی ارسال شده و تایید شده است )مربوط به کسب و کار حقوقی است (.
      • introduction_letter :شامل دو مقدار add, accepted است که در مورد اول باید معرفی نامه کسب و کار خود را ارسال کنید و اگر مورد دوم باشد یعنی معرفی نامه شما ارسال شده و تایید شده است ( مربوط به کسب و کار حقوقی است ). .
    • status : داراس سه مقدار -۱و۰و۱ است که به ترتیب به معنای رد شدن کسب و کار شما، در حال بررسی کسب و کار شما یا در نهایت تایید شدن کسب و کار شما است
    • role_name : بیانگر نقش شما در کسب وکار است (همچون مدیر، ناظر و ..).
    • role : بیانگر نقش شما در کسب وکار است (همچون Owner، Observer و ..).
    • 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 : ابزار های کسب و کار را میگوید و دارای دو فیلد is_enabled, is_created است که اولی میگوید این ابزار فعال است و دومی میگوید ایا ساخته شده است یا خیر که ابزار ها :
      • ipg : سرویس درگاه پرداخت
      • subscription : سرویس اشتراک
      • requestMoney : سرویس فرم دریافت پول
      • api :
      • customer : سرویس مشتریان
      • log :

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

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

اطلاعات

در این بخش اطلاعات مربوط به کسب و کار خاصی نمایش داده میشود نکته: به جای {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
                            

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

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: نوع خطا را نمایش میدهد