کافه فالوور

API

مقدمه

این راهنما نحوه ی استفاده از وب سرویس توسط آدرس ها، متد ها و پارامتر های ذکر شده را به نمایندگان توضیح می دهد.

توجه داشته باشید بدنه تمامی درخواست ها و پاسخ ها با فرمت JSON می باشد.

احراز هویت

برای استفاده از وب سرویس نیاز است ابتدا یک حساب کاربری برای خودتان بسازید، سپس از بخش پروفایل درخواست نمایندگی خود را برای ما ارسال نمایید. پس از بررسی و تایید بخشی به عنوان وب سرویس به پنل شما اضافه خواهد شد با ورود به بخش یاد شده می توانید کلید API KEY را برداشت نمایید.

برای ارسال تمامی درخواست ها باید API KEY را مانند مثال زیر در header ارسال نمایید:

X-API-KEY: 48:14cb6c1a-eb7b-4367-b3cf-8b198811f3df

نکته 1: در پنل وب سرویس شما می توانید ip های خود را ثبت نمایید، در این صورت تنها ip های وارد شده امکان ارسال و استفاده از وب سرویس را خواهند داشت.

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

سفارش فالوور

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

POST

با اطلاعات زیر به آدرس یاد شده ارسال نمایید.
https://cofe-follower.com/api/orderFollower/

پارامتر های ارسالی

نام نوع شرح
requested Integer تعداد درخواست شما که باید حداقل و حداکثر تعداد درخواست را مطابق سایت رعایت نماید.
username String یوزرنیم کاربر بدون پسوند و پیشوند (@)

نمونه درخواست PHP

$param = array(
  'requested' => 100,
  'username' => 'username',
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://cofe-follower.com/api/orderFollower/');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'Content-Type: application/json',
  'X-API-KEY: 48:14cb6c1a-eb7b-4367-b3cf-8b198811f3df'
));

$result = curl_exec($ch);
curl_close($ch);

var_dump($result);

نمونه پاسخ موفق

{
   "ok":true,
   "result": {
        "order_id":100,
        "amount":2000,
        "credit":2000,
        "left_over":5900
    }
}

پارامتر های دریافتی

نام نوع شرح
order_id Integer شناسه منحصر بفرد سفارش که برای پیگیری های آتی استفاده می شود
amount Integer هزینه کسر شده بابت سفارش
credit Integer موجودی حساب شما بعد از کسر هزینه
left_over Integer تعداد درخواست باقی مانده از سقف مجاز روزانه

لیست کد های خطا درصورت ناموفق بودن درخواست

  • 400
  • 401
  • 403
  • 405
  • 415
  • 502
  • 1
  • 2
  • 3
  • 4
  • 5

سفارش لایک

برای ثبت سفارش لایک نیاز است درخواست های خود را به صورت

POST

با اطلاعات زیر به آدرس یاد شده ارسال نمایید.
https://cofe-follower.com/api/orderLike/

پارامتر های ارسالی

نام نوع شرح
requested Integer تعداد درخواست شما که باید حداقل و حداکثر تعداد درخواست را مطابق سایت رعایت نماید.
post_code String الزامیست تنها کد پست را ارسال نمایید.
راهنمای دریافت کد پست
اگر لینک زیر یک پست اینستاگرامی باشد،کد پست داخل لینک قرار دارد.
https://www.instagram.com/p/CsXo-kAbg25u/?utm_source=ig_web_copy_link - Post code is CsXo-kAbg25u

نمونه درخواست PHP

$param = array(
  'requested' => 100,
  'post_code' => 'post_code',
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://cofe-follower.com/api/orderLike/');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'Content-Type: application/json',
  'X-API-KEY: 48:14cb6c1a-eb7b-4367-b3cf-8b198811f3df'
));

$result = curl_exec($ch);
curl_close($ch);

var_dump($result);

نمونه پاسخ موفق

{
   "ok":true,
   "result": {
        "order_id":100,
        "amount":2000,
        "credit":2000,
        "left_over":5900
    }
}

پارامتر های دریافتی

نام نوع شرح
order_id Integer شناسه منحصر بفرد سفارش که برای پیگیری های آتی استفاده می شود
amount Integer هزینه کسر شده بابت سفارش
credit Integer موجودی حساب شما بعد از کسر هزینه
left_over Integer تعداد درخواست باقی مانده از سقف مجاز روزانه

لیست کد های خطا درصورت ناموفق بودن درخواست

  • 400
  • 401
  • 403
  • 405
  • 415
  • 502
  • 1
  • 2
  • 3
  • 4
  • 5

وضعیت سفارش

بعد از ثبت سفارش با استفاده از order_id دریافتی در مراحل قبل می توانید از آخرین وضعیت سفارش خود مطلع گردید. برای این کار نیاز است حتما درخواست خود را به صورت

GET

ارسال نمایید.
https://cofe-follower.com/api/orderStatus/

پارامتر های ارسالی

نام نوع شرح
order_id Integer شناسه سفارش ثبت شده

نمونه درخواست PHP

$param = array(
  'order_id' => 1001
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://cofe-follower.com/api/orderStatus/?'.http_build_query($param));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'X-API-KEY: 6:6cce4000-1d54-4c38-9dcf-0b42ede9c09b'
));

$result = curl_exec($ch);
curl_close($ch);

var_dump($result);

نمونه پاسخ موفق

{
   "ok":true,
   "result": {
        "start_count": 128,
        "order_status":"finished",
        "order_type":"follower",
        "requested":100,
        "received":105,
        "address":"@username",
        "created":"2020-09-21 18:15:64"
    }
}

پارامتر های دریافتی

نام نوع شرح
start_count Integer تعداد شروع اولیه
order_status String وضعیت سفارش را تعیین می نماید
order_type String نوع سفارش را مشخص می کند و دارای مقادیر follower یا like می باشد
requested Integer تعداد درخواست شده
received Integer تعداد دریافت شده
address String اطلاعات سفارش
created DateTime تاریخ و زمان ثبت سفارش به مبدا تهران
وضعیت های order_status:
  • queue: سفارش شما در صف ارسال است.
  • running: سفارش با موفقیت ثبت شده و درحال انجام است.
  • finished: سفارش تکمیل شده است.
  • stopped: سفارش متوقف شده است،درصورتی که حساب کاربر غیرفعال گردد یا برای پست ها خصوصی یا پست حذف گردد و هر خطایی که امکان تکمیل شدن سفارش را بگیرد.
  • deleted: سفارش به دلیل داشتن محتوای نامناسب و نقض قوانین حذف شده است.
دریافتی می تواند از درخواستی شما بیشتر شود، این به این معناست بیش از درخواست خود دریافت کرده اید.

لیست کد های خطا درصورت ناموفق بودن درخواست

  • 400
  • 401
  • 403
  • 405

لیست خطا ها

نمونه پاسخ ناموفق برای کلیه درخواست ها به صورت زیر است

{
   "ok":false,
   "error_code":401,
   "description":"Unauthorized"
}

جدول کد ها و خطا ها

کد متن خطا توضیحات
401 Unauthorized احراز هویت انجام نشده است، از صحت و ارسال صحیح API KEY اطمینان حاصل نمایید.
405 Method Not Allowed نوع درخواست به درستی تنظیم نشده است.
403 IP 'your ip' Not Allowed ip درخواست کننده در لیست مجاز ثبت شده نیست.
400 Bad Request: Minimum And Maximum Are Not Observed | Bad Request: Order Not Found | ... یکی از پارامتر های ارسالی صحیح نیست، توضیحات بیشتر در متن خطا گفته شده است.
415 Content Type Not Allowed content type به درستی تنظیم نشده است.
502 Failed To Get (Post or Username) Information خطای نامشخصی در دریافت اطلاعات یوزرنیم یا پست رخ داده است، همچنین درصورتی که یوزرنیم اشتباه یا غیرفعال شده باشد و یا پست خصوصی یا وجود نداشته باشد، این خطا را در هر حالتی به منظور ناموفق بودن پست یا یوزرنیم دریافت خواهید کرد.
1 Order Is Disabled ثبت سفارش سایت بسته شده است، کاربران و حتی نمایندگان برای مدتی امکان ثبت سفارش را ندارند تا بروزرسانی یا تغییرات سایت به اتمام رسد.
2 You Are Not Allowed To Order شما امکان ثبت سفارش فالو یا لایک را ندارید، اطلاع از دسترسی داشتن به ثبت سفارش را می توانید در پنل مشاهده کنید.
3 You Have Used Your Maximum Order Per Day شما روزانه نمی توانید بیش از سقف مشخص شده درخواست فالوور یا لایک نمایید، اطلاع از باقی مانده ثبت سفارش با نماینده است که در هر ثبت سفارش موفق تعداد را نزد خود نگه دارد، همچنین اگر این سقف را کم می دانید با ما در تماس باشید.
4 Account Credit Is Not Enough To Order موجودی حساب شما برای انجام این سفارش ناکافی است،ابتدا پنل خود را به اندازه کافی شارژ نمایید.
5 An Unspecified Error Occurred درصورت رخ داد هرگونه خطای پیشبینی نشده، این پیام را دریافت خواهید کرد.