توضیحات مقدماتی وبسرویس BASIC
شما برای استفاده از این وبسرویس باید توکن مربوط به حساب کاربری خود را بسازید و سپس با توکن ساخته شده درخواست های خود را ارسال کنید ، شما علاوه بر توکن باید متود وبسرویس را نیز مشخص کنید در این وبسرویس 3 نوع متود وجود دارد. که در پایین به توضیح دادن آنها پرداخته ایم.
هر متود برای خود یک سری پارامتر های متفاوت و مختلفی دارد که شما به صورت "GET" و یا "POST" میتوانید پارامتر ها را ارسال کنید
لینک درخواست به شرح زیر است
به جای [TOKEN] و [METHOD] توکن و متود خود را قرار میدهیم
https://top-follow.com /api/v1/[TOKEN]/[METHOD]
یک نمونه از ارسال درخواست به وبسرویس
https://top-follow.com/api/v1/top-follow.com-KjUyh*****-98jYmd******/UserInfo
پارامتر های ارسالی که میتوانید به عنوان متود ارسال کنید
| نام | توضیحات |
|---|---|
| UserInfo | برای دریافت مشخصات حساب کاربری (دریافت موجودی و نوع اشتراک و تاریخ انقضای اشتراک) |
| NewOrder | برای ثبت سفارش جدید |
| MyOrders | مشاهده سفارش های صورت گرفته توسط شما (قیمت خرید - تعداد خرید - وضعیت خرید و ... ) |
راهنمای خطا های که ممکن است در هنگام ارسال درخواست دریافت کنید
هنگام ارسال درخواست ممکن است در پارامتر error_code عدد های زیر را دریافت کنید.
0: توکن ارسال نشده است
1: توکن وارد شده معتبر نمیباشد
2: متود وارد نشده است
3: متود وارد شده معتبر نمیباشد
4: ایدی محصول را وارد نکرده اید
5: ایدی محصول وارد شده معتبر نیست
6: اشتراکی برای شما فعال نیست
7: موجودی حساب شما کافی نمیباشد
8: تعداد سفارش وارد شده معتبر نمیباشد ، تعداد سفارش باید بین حداقل و حداکثر باشد.
9: لینک وارد شده برای سفارش معتبر نمیباشد
10: سفارشی یافت نشد
11: سفارشی در این صفحه یافت نشد
استعلام حساب METHOD
برای مشاهده موجودی و دیگر مشخصات حساب نیاز نیست که عبارت خاصی ارسال کنید همین که لینک زیر را همراه با توکن خود و متود "UserInfo" فراخوانی کنید مشخصات حساب را دریافت خواهید کرد
https://top-follow.com/api/v1/top-follow.com-KjUyh*****-98jYmd******/UserInfo
پارامتر و اطلاعاتی که پس از ارسال درخواست دریافت میکنید
| نام | جنس داده | توضیحات |
|---|---|---|
| ok | [BOOLEAN] | در صورتی که درخواست با موفقیت اجرا شود و بدون error_code باشد خروجی این مقدار برابر "true" میباشد. در غیر این صورت خروجی "false" خواهد شد. |
| coin | [INT] | این مقدار به تومان میباشد و موجودی کنونی شما را نمایش میدهد |
| rank | [STRING] | این مقدار در 5 حالت ممکن است باشد : free - bronze - silver - gold - diamond |
| expire_rank | [STRING] | این مقدار تاریخ و ساعت پایان اشتراک شما به صورت ساختار تاریخ برمیگرداند |
| error_code | [INT] | این عدد ها نشان گر خطای پیش آمده است برای مشاهده و درک بیشتر به بخش "توضیحات مقدماتی" مراجعه نمایید |
نمونه درخواست دریافتی موفق
{
"ok":true,
"coin":87000,
"rank":"diamond",
"expire_rank":"1400/12/29 23:59",
}
نمونه درخواست دریافتی ناموفق
{
"ok":false,
"error_code":1,
}
سفارش جدید محصول
برای سفارش جدید محصول بایستی 3 پارامتر "product_id" ، "order_for" ، "count" ارسال کنید . البته در نظر داشته باشید که برای محصولاتی که تعدادشان از پیش تعیین شده است نمیتوان مقدار "count" مشخص کرد.
نمونه لینک درخواستی
لینک ارسالی باید شامل توکن اختصاصی شما و متود "NewOrder" باشد. شما میتوانید پارامتر های ارسالی را به صورت "GET" و یا "POST" ارسال کنید
https://top-follow.com/api/v1/top-follow.com-KjUyh*****-98jYmd******/NewOrder
در این جدول به طور کامل توضیح خواهیم داد که چه عبارت هایی و به چه صورتی باید ارسال شود
| نام | جنس داده | توضیحات |
|---|---|---|
| product_id | [INT] | جهت مشاهده تمامی ایدی محصولات به این صفحه مراجعه کنید |
| count | [INT] | این مقدار بسته به تعداد مورد نیاز شما میباشد فقط باید به min-max محصولات توجه کنید min-max هر محصول در این صفحه موجود است. |
| order_for | [STRING] | لینک پست و یا یوزرنیم پیچ بستگی به نوع محصول دارد |
سفارش های شما
برای مشاهده سفارش های انجام شده توسط خودتان بایستی توکن اختصاصی خود را همراه با متود "MyOrders" در لینک جایگذاری کنید و سپس درخواست خود را ارسال کنید
توجه داشته باشید که 15 سفارش اخیر در درخواست شما ارسال میشود برای مشاهده بیشتر باید از پارامتر "page" استفاده کنید و صفحه خود را وارد کنید.
نمونه لینک درخواستی
لینک ارسالی باید شامل توکن اختصاصی شما و متود "MyOrders" باشد. شما میتوانید پارامتر های ارسالی را به صورت "GET" و یا "POST" ارسال کنید
https://top-follow.com/api/v1/top-follow.com-KjUyh*****-98jYmd******/MyOrders
در این جدول به طور کامل توضیح خواهیم داد که چه عبارت هایی و به چه صورتی باید ارسال شود
| نام | جنس داده | توضیحات |
|---|---|---|
| page | [INT] | تعداد صفحات بستگی به تعداد سفارش های شما دارد و در هر صفحه جزعیات هر 15 سفارش نمایش داده میشود |
پنل توسعه دهندگان
-
BASIC
توضیحات مقدماتی
-
METHOD
استعلام حساب
-
METHOD
سفارش جدید
-
METHOD
سفارش های من