یادآمد

باشگاه مشتریان و فروشگاه

وب سرویس یادآمد چیست؟

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

توجه : جهت استفاده از وب سرویس می بایست اشتراک خود را به ویژه ارتقا دهید. پس از ارتقا در صفحه میز کار باشگاه مشتریان امکان دریافت کلید اختصاصی وب سرویس وجود دارد.

 

در تمامی سرویس ها در پارامتر خروجی فیلد state وجود دارد که وضعیت سرویس با توجه به پارامتر های ورودی را نشان می دهد.

بخش state :

نام
نوع
توضیحات
message
String
پیام سرویس
status
String
وضعیت سرویس
status
String
کد سرویس

وب سرویس دریافت اعتبار

آدرس وب سرویس :

https://yadapi.ir/webservice/credit

توضیحات :

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

پارامترهای ورودی :

نام
نوع
توضیحات
apikey
String(32)
کلید اختصاصی وب سرویس

در نظر داشته باشید پارامتر ها را از طریق متد POST ارسال نمایید.

پارامترهای خروجی :

خروجی سرویس به صورت JSON می باشد.

خروجی از دو قسمت data و state تشکیل شده است.

بخش data :

نام
نوع
توضیحات
credit
String
اعتبار کاربر
currency
String
واحد پول 
				
					{
    "data": {
        "credit": "171166000",
        "currency": "toman"
    },
    "state": {
        "message": "عملیات با موفقیت انجام شد.",
        "status": "ok",
        "code": "10"
    }
}

وب سرویس اعتبار سنجی کاربر

آدرس وب سرویس :

https://yadapi.ir/webservice/authenticate

توضیحات :

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

پارامترهای ورودی :

نام
نوع
توضیحات
apikey
String(32)
کلید اختصاصی وب سرویس

در نظر داشته باشید پارامتر ها را از طریق متد POST ارسال نمایید.

پارامترهای خروجی :

خروجی سرویس به صورت JSON می باشد.

خروجی از دو قسمت data و state تشکیل شده است.

بخش data :

نام
نوع
توضیحات
apikey
String(32)
کلید اختصاصی 
				
					{
    "data": {
        "apikey": "API-KEY"
    },
    "state": {
        "message": "عملیات با موفقیت انجام شد.",
        "status": "ok",
        "code": "10"
    }
}

وب سرویس افزودن مشتری

آدرس وب سرویس :

https://yadapi.ir/webservice/customer/add

توضیحات :

از این متد جهت افزودن مشتری در باشگاه مشتریان اختصاصی استفاده می شود.

پس از ثبت اطلاعات مشتری یک پیامک با توجه به تنظیمات و متون پیش فرض به موبایل مشتری ارسال خواهد شد.

پارامترهای ورودی :

نام
نوع
توضیحات
apikey
String(32)
کلید اختصاصی وب سرویس
request
json
پارامترهای ارسالی

پارامتر های ورودی متغییر request به صورت json مانند زیر می باشد :

نام
نوع
توضیحات
mobile
String(10)
موبایل مشتری
name
String(50)
نام و نام خانوادگی مشتری
gender
String(3)
جنسیت مشتری
day
String(2)
روز تولد مشتری
month
String(2)
ماه تولد مشتری
category
String(5)
شناسه دسته بندی مشتری 
				
					{
    "mobile": "9121234567",
    "name": "علی احمدی",
    "gender": "مرد",
    "day": "11",
    "month": "12",
    "category": "23"
}

در نظر داشته باشید پارامتر ها را از طریق متد POST ارسال نمایید.

پارامترهای خروجی :

خروجی سرویس به صورت JSON می باشد.

				
					{
    "state": {
        "message": "عملیات با موفقیت انجام شد.",
        "status": "ok",
        "code": "10"
    }
}

وب سرویس ارسال پیام به مشتری

آدرس وب سرویس :

https://yadapi.ir/webservice/customer/send

توضیحات :

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

توجه : در نظر داشته باشید اگر موبایل مشتری بار اول در وب سرویس ارسال شود، ابتدا یک پیامک با توجه به تنظیمات و متون پیش فرض به موبایل مشتری ارسال خواهد شد و سپس متن ارسالی شما به مشتری ارسال می شود.

پارامترهای ورودی :

نام
نوع
توضیحات
apikey
String(32)
کلید اختصاصی وب سرویس
request
json
پارامترهای ارسالی

پارامتر های ورودی متغییر request به صورت json مانند زیر می باشد :

نام
نوع
توضیحات
mobile
String(10)
موبایل مشتری
message
String(250)
متن ارسالی 
				
					{
    "mobile": "9121234567",
    "message": "این متن تست می باشد."
}

در نظر داشته باشید پارامتر ها را از طریق متد POST ارسال نمایید.

پارامترهای خروجی :

خروجی سرویس به صورت JSON می باشد.

خروجی از دو قسمت data و state تشکیل شده است.

بخش data :

نام
نوع
توضیحات
refid
String(11)
شناسه ارسال پیامک 
				
					{
    "data": {
        "refid": "123456"
    },
    "state": {
        "message": "عملیات با موفقیت انجام شد.",
        "status": "ok",
        "code": "10"
    }
}

وب سرویس دریافت اطلاعات مشتری

آدرس وب سرویس :

https://yadapi.ir/webservice/customer/info

توضیحات :

از این متد جهت دریافت اطلاعات مشتری استفاده می شود.

پارامترهای ورودی :

نام
نوع
توضیحات
apikey
String(32)
کلید اختصاصی وب سرویس
request
json
پارامترهای ارسالی

پارامتر های ورودی متغییر request به صورت json مانند زیر می باشد :

نام
نوع
توضیحات
mobile
String(10)
موبایل مشتری 
				
					{
    "mobile": "9121234567",
}

در نظر داشته باشید پارامتر ها را از طریق متد POST ارسال نمایید.

پارامترهای خروجی :

خروجی سرویس به صورت JSON می باشد.

خروجی از دو قسمت data و state تشکیل شده است.

بخش data :

نام
نوع
توضیحات
mobile
String(10)
موبایل مشتری
name
String(50)
نام مشتری
gender
String(3)
جنسیت مشتری
day
String(2)
روز تولد مشتری
month
String(2)
ماه تولد مشتری
category
String(3)
دسته بندی مشتری مشتری 
				
					{
    "data": {
        "mobile": "9128475975",
        "name": "علی احمدی",
        "gender": "مرد",
        "day": "11",
        "month": "12",
        "category": "23"
    },
    "state": {
        "message": "عملیات با موفقیت انجام شد.",
        "status": "ok",
        "code": "10"
    }
}

لیست خطاهای وب سرویس

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

بخش state :

کد
نوع
توضیحات
10
عملیات با موفقیت انجام شد.
11
کلید اختصاصی وب سرویس معتبر نمی باشد.
12
خطا در دریافت اعتبار کاربر!
13
خطا در متد ارسالی!
14
خطا در دریافت اطلاعات کاربر!
15
موبایل را به درستی وارد نمایید!
16
متن را به درستی وارد نمایید!
17
نام و نام خانوادگی را به درستی وارد نمایید!
18
جنسیت را به درستی وارد نمایید!
19
روز تولد را به درستی وارد نمایید!
20
ماه تولد را به درستی وارد نمایید!
21
دسته بندی را به درستی وارد نمایید!
22
مشتری با این موبایل وجود ندارد!
23
قابلیت وب سرویس غیرفعال است!