جهت برقراری ارتباط دو طرفه شکلات با نرم افزار شما نیاز به دریافت Accesses Token یا به اختصار AT می باشید جهت دریافت AT به منوی فعال سازی مراجعه و با فعال کردن وب سرویس شعبه مربوطه کد AT را دریافت نمائید.

در مرحله ی بعدی شما باید آدرس های فراخوانی خود را به شکلات معرفی کنید. برای این کار به منوی وب سرویس و زیرمنوی تنظیمات مراجعه کنید و به شکلات بگویید در صورت ثبت مشتری جدید یا محصول و یا حتی فاکتور جدید چه آدرسی را فراخوانی کند.
زیبا نیست ؟ به همین راحتی شما میتوانید از امکانات وب سرویس استفاده کنید.
حال برای شما سوال پیش می آید چه اطلاعاتی شکلات برای من میفرستد و چه اطلاعاتی می توانم از شکلات دریافت کنم ؟ بیایید با هم شروع کنید ...

تغییرات این نسخه

دریافت مشخصات شعبه

آدرس :

/api/webhook/v2/branch/pull

پارامترها :

فرمت پاسخ :

{
    "id": "کدشناسایی در شکلات",
    "name": "نام شعبه",
    "guild": "نام صنف شعبه",
    "city": "نام شهر شعبه"
}

دریافت لیست مشخصات مشتریان شکلات

شما میتوانید لیست مشخصات تمام مشتریان شکلات را همراه با کد شناسایی آن ها (ID) دریافت کنید.

آدرس :

/api/webhook/v2/customers/pull

پارامترها :

فرمت پاسخ :

[
    {
        "id": "کد شناسایی در شکلات",
        "name": "نام مشتری",
        "family": "نام خانوادگی مشتری",
        "mobile": "موبایل مشتری",
        "status": "وضعیت مشتری : 1 به معنی فعال و 0 به معنی غیر فعال",
        "card_no": "شماره کارت مشتری",
        "last_buy": "تاریخ آخرین خرید مشتری",
    },
    .
    .
    .
]

دریافت امتیاز، اعتبار و مشخصات یک مشتری

با ارسال پارامترهای زیر، می توانید امتیازکل، امتیاز باقی مانده، اعتبار ، گروه مشتری و دیگر مشخصات مشتری را دریافت کنید.

می‌توانید یکی از پارامترهای "customer_id" و یا "mobile" را ارسال کنید و نیازی به ارسال هر دو پارامتر نیست.

آدرس :

/api/webhook/v2/customer/pull

پارامترها :

فرمت پاسخ :

{
    "all_score": "امتیاز کل",
    "remaining_score": "امتیاز باقی مانده",
    "credit": "میزان اعتبار باقی مانده",
    "group": "نام گروه مشتری",
    "name": "نام",
    "family": "نام خانوادگی",
    "registration_code": "شماره عضویت مشتری",
    "customer_id": "customer id in Shokolat",

}

دریافت لیست گروه مشتریان

در این API شما میتوانید لیست گروه های مشتریان را به راحتی دریافت کنید.

آدرس :

/api/webhook/v2/customer/groups/pull

پارامترها :

فرمت پاسخ :

[
     {
        "id": "کد گروه مشتری در شکلات",
        "name": "نام گروه مشتری",
        "is_starting_group": "آیا گروه آغازین می باشد ؟ 1 به معنی بله و 0 به معنی خیر"
    },
    .
    .
    .
]

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

با صدا زدن این API شما به راحتی آب خوردن می توانید یک مشتری جدید اضافه کنید

آدرس :

/api/webhook/v2/customer/push

پارامترها :

فرمت پاسخ :

{
    "id": "کد مشتری ثبت شده در شکلات",
    "mobile": "موبایل مشتری ثبت شده"
}

همگام سازی مشتریان با شکلات

با صدا زدن این API شما می توانید لیست مشتریان خود را برای شکلات بفرستید و شکلات آنها را ذخیره کرده و سپس ID های آنها را برای شما فرستاده و به دنبال آن لیست مشتریان خود را نیز برای شما ارسال میکند

[
    {
        "name": "نام مشتری شما",
        "family": "نام خانوادگی مشتری شما",
        "mobile": "موبایل مشتری شما"
    },
    .
    .
    .
]

آدرس :

/api/webhook/v2/customers/sync

پارامترها :

فرمت پاسخ :

{
    "inserted_customers": [
        {
            "id": "کد شناسایی مشتری ثبت شده در شکلات",
            "mobile": "موبایل مشتری ثبت شده در شکلات",
        },
        .
        .
        .
    ],
    "customers": [
        {
            "id": "کد شناسایی در شکلات",
            "name": "نام مشتری",
            "family": "نام خانوادگی مشتری",
            "mobile": "موبایل مشتری",
            "status": "وضعیت مشتری : 1 به معنی فعال و 0 به معنی غیر فعال"
        },
        .
        .
        .
    ]
}

{
    "error": "no response from your server"
}

کسر از اعتبار مشتری

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

آدرس :

/api/webhook/v2/customer/expend/credit

پارامترها :

فرمت پاسخ :

{
    "msg": "اعتبار با موفقیت از حساب مشتری کاسته شد."
}

{
    "msg": "میزان اعتبار وارد شده از میزان اعتبار مشتری بیشتر است."
}

{
    "msg": "مشتری اعتبار ندارد"
}

افزایش اعتبار مشتری

با ارسال پارامترهای زیر، میتوانید مقدار مورد نیاز به اعتبار مشتری اضافه کنید.

آدرس :

/api/webhook/v2/customer/inc/credit

پارامترها :

فرمت پاسخ :

{
    "msg": "اعتبار با موفقیت به مشتری افزوده شد."
}

افزایش امتیاز مشتری

با ارسال پارامترهای زیر، میتوانید مقدار مورد نیاز را به امتیاز مشتری اضافه کنید.

آدرس :

/api/webhook/v2/customer/inc/score

پارامترها :

فرمت پاسخ :

{
    "msg": "امتیاز با موفقیت به مشتری افزوده شد."
}

کسر از امتیاز مشتری

با ارسال پارامترهای زیر، میتوانید مقدار مورد نیاز را به امتیاز مشتری اضافه کنید.

آدرس :

/api/webhook/v2/customer/expend/score

پارامترها :

فرمت پاسخ :

{
    "msg": "امتیاز با موفقیت از مشتری کسر شد."
}

دریافت لیست مشخصات محصولات شکلات

شما میتوانید لیست مشخصات تمام محصولات شکلات را همراه با کد شناسایی آن ها (ID) دریافت کنید.

آدرس :

/api/webhook/v2/products/pull

پارامترها :

فرمت پاسخ :

[
    {
        "id": "کد شناسایی در شکلات",
        "name": "نام محصول",
        "barcode": "بارکد محصول",
        "price": "مبلغ محصول که به ریال می باشد",
        "status": "وضعیت محصول : 1 به معنی فعال و 0 به معنی غیر فعال",
        "stock_count": "موجودی انبار"
    },
    .
    .
    .
]

دریافت لیست محصول های یک گروه

در این API شما میتوانید لیست محصول های گروه را به راحتی دریافت کنید.

آدرس :

/api/webhook/v2/group/products/pull

پارامترها :

فرمت پاسخ :

[
    {
        "id": "کد شناسایی در شکلات",
        "name": "نام محصول",
        "barcode": "بارکد محصول",
        "price": "مبلغ محصول که به ریال می باشد",
        "status": "وضعیت محصول : 1 به معنی فعال و 0 به معنی غیر فعال",
        "stock_count": "موجودی انبار"
    },
    .
    .
    .
]

دریافت لیست گروه محصولات

در این API شما میتوانید لیست گروه های محصولات را به راحتی دریافت کنید.

آدرس :

/api/webhook/v2/product/groups/pull

پارامترها :

فرمت پاسخ :

[
     {
        "id": "کد گروه محصولات در شکلات",
        "name": "نام گروه محصولات"
    },
    .
    .
    .
]

افزودن محصول جدید به شکلات

با صدا زدن این API شما به راحتی آب خوردن می توانید یک محصول جدید اضافه کنید

آدرس :

/api/webhook/v2/product/push

پارامترها :

فرمت پاسخ :

{
    "id": "کد محصول ثبت شده در شکلات"
}

ویرایش محصول موجود در شکلات

در اینجا شما می توانید به راحتی یک محصول را ویرایش کنید.

آدرس :

/api/webhook/v2/product/patch

پارامترها :

فرمت پاسخ :

{
    "id": "کد محصول ویرایش شده در شکلات"
}

همگام سازی محصولات با شکلات

با صدا زدن این API شما می توانید لیست محصولات خود را برای شکلات بفرستید و شکلات آنها را ذخیره کرده و سپس ID های آنها را برای شما فرستاده و به دنبال آن لیست محصولات خود را نیز برای شما ارسال میکند

[
    {
        "name": "نام محصول شما",
        "barcode": "بارکد محصول شما",
        "price": "مبلغ محصول شما به ریال",
        "status": "وضعیت محصول شما : 0 به معنی غیرفعال و 1 به معنی فعال",
        "stock_count": "موجودی انبار کالا"
    },
    .
    .
    .
]

آدرس :

/api/webhook/v2/products/sync

پارامترها :

فرمت پاسخ :

{
    "inserted_products": [
        {
            "name": "نام محصول شما",
            "barcode": "بارکد محصول شما",
            "shokolat_id": "کد شناسایی محصول ثبت شده در شکلات",
        },
        .
        .
        .
    ],
    "products": [
        {
            "id": "کد شناسایی در شکلات",
            "name": "نام محصول",
            "barcode": "بارکد محصول",
            "price": "مبلغ محصول که به ریال می باشد",
            "status": "وضعیت محصول : 1 به معنی فعال و 0 به معنی غیر فعال"
            "stock_count": "موجودی انبار"
        },
        .
        .
        .
    ]
}

{
    "error": "no response from your server"
}

ثبت صورتحساب جدید در شکلات

شما میتوانید به راحتی یک فاکتور در شکلات ثبت کنید. کافی است پارامترهای زیر را ارسال کنید تا فاکتور با موفقیت ثبت شود.

آدرس :

/api/webhook/v2/factor/push

پارامترها :

2019-10-09 10:23:40

[
    {
        "product_id": "کد شناسایی محصول در شکلات",
        "is_gift": "آیا این محصول هدیه است ؟ 1 به معنی بله و 0 به معنی خیر",
        "unit_price": "مبلغ واحد به ریال",
        "count": "تعداد محصول"
    },
    .
    .
    .
]

فرمت پاسخ :

{
    "id": "کد فاکتور ثبت شده در شکلات"
}

{
    "status": 420,
    "error": "مشتری اعتبار ندارد"
}

پیش پردازش فاکتور

از اسمش نترسید چیزی نیست. با استفاده از این API شما می توانید ببینید با توجه به شرایط فاکتور چه طرح هایی شامل حال آن شده و همچنین میزان اعتبار قابل مصرف مشتری در داخل این فاکتور و همچنین امتیاز کاربر و اعتبار کلی او چه میزان می باشد.

آدرس :

/api/webhook/v2/factor/process

پارامترها :

1398/06/25 12:15

[
    ,"کد شناسایی محصول در شکلات"
    ,"کد شناسایی محصول در شکلات"
    .
    .
    .
]

فرمت پاسخ :

{
    "score": "میزان امتیاز دریافتی بابت این فاکتور",
    "credit": "میزان اعتبار دریافتی بابت این فاکتور",
    "credit_can_use": "میزان اعتبار قابل مصرف در این فاکتور",
    "discount": "مجموع میزان تخفیف دریافتی بابت طرح ها در این فاکتور",
    "plan_name": [
            "نام طرح ها متعلق به این فاکتور",
            "نام طرح ها متعلق به این فاکتور",
            .
            .
            .
        ],
    "product_id": [
            "کد محصول در شکلات تعلق گرفته توسط طرح ها",
            "کد محصول در شکلات تعلق گرفته توسط طرح ها",
            .
            .
            .
        ],
    "product_name": [
            "نام محصول در شکلات تعلق گرفته توسط طرح ها",
            "نام محصول در شکلات تعلق گرفته توسط طرح ها",
            .
            .
            .
        ],
    "product_price": [
            "مبلغ محصول در شکلات تعلق گرفته توسط طرح ها",
            "مبلغ محصول در شکلات تعلق گرفته توسط طرح ها",
            .
            .
            .
        ],
    "product_discount": [
            "درصد تخفیف محصول در شکلات تعلق گرفته توسط طرح ها",
            "درصد تخفیف محصول در شکلات تعلق گرفته توسط طرح ها",
            .
            .
            .
        ]
}

فراخوانی رویداد

شما میتوانید رویداد جدیدی در پنل ثبت کنید. در صورتی که نوع آن را سفارشی بگذارید و آن را ثبت نمائید؛ پس از ثبت یک کد برای شما در لیست رویدادهایتان نمایش داده می شود. با این کد می توانید این رویداد را از طریق این API فراخوانی کنید.

آدرس :

/api/webhook/v2/event/call

پارامترها :

فرمت پاسخ :

{
     "result" : "رویداد با موفقیت فراخوانی شد."
}

{
     "result" : "امتیاز مشتری ناکافی می باشد."
}

{
   "result" : "در فراخوانی رویداد به شکست برخوردیم."
}