آموزش استفاده از بی‌بات

در این صفحه قصد داریم تا شما را با نحوه پیاده سازی و استفاده از بی‌بات آشنا کنیم.


دریافت کلید سایت

برای دریافت کلید بی‌باتِ سایتِ خود، ابتدا به پنل کاربری سایت مراجعه کنید.

سپس از منوی سمت راست سرویس‌های من > سرویس جدید را انتخاب کنید.

و در آخر با اضافه کردن دامنه خود کلیدهای عمومی و مخفی سایت خود را دریافت کنید. کلیدهای شما پس از ۱۰۰ ثانیه فعال می‌شوند.


نمایش خودکار بی‌بات

برای استفاده از بی‌بات کافیست که در فرم مورد نظر المان div را بسازید و کلاس bibot-captcha را به آن اضافه کنید و کلید عمومی سایت خود را در صفت data-sitekey آن قرار دهید.

برای تعیین زبان پیشفرض بی‌بات شما باید صفت data-lang را برابر با نماد زبان مورد نظر خود قرار دهید.

زبان پیشفرض بی‌بات از تاریخ ۹۸/۴/۱ به زبان انگلیسی تغییر خواهد کرد!

<!DOCTYPE html>
<html>
<head>
 <title>Bibot Example</title>
</head>
<body>
 <form action="?" method="POST">
  <div class="bibot-captcha" data-sitekey="کلید سایت شما" data-lang="fa"></div>
  <script src="https://cdn.bibot.ir/bibot.min.js"></script>
  <input type="submit" value="Submit">
 </form>
</body>
</html>

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


تایید نهایی عملیات

شما باید پس از پایان فرایند تایید هویت، در بخش سمت سرور سایت خود خروجی بی‌بات را تایید نهایی کنید. برای این منظور ابتدا شما باید پارامتر bibot-response را دریافت کنید.

دریافت پارامتر bibot-response به دو صورت ممکن است:

  • بی‌بات در فرم‌ها:
    در این حالت شما داده bibot-response را به عنوان یکی از پارامتر‌های ارسال شده‌ی فرم در بخش سمت سرور سایت خود دریافت خواهید کرد.
  • استفاده از data-callback:
    شما می‌توانید در المان div بی‌بات خود صفت data-callback را برابر با اسم نام تابعی از جاوااسکریپت سمت کاربر خود بنویسید و bibot-response را به عنوان پارامتر ورودی آن تابع دریافت کنید.

حال شما باید با ارسال این متغیر به سرور بی‌بات از صحت آن اطمینان حاصل کنید.


نحوه درخواست تایید بی‌بات

برای ارسال درخواست باید به آدرس https://api.bibot.ir/api1/siteverify/ یک درخواست از نوع پست بزنید و کلید مخفی و bibot-response را همراه آن ارسال کنید.

URL: https://api.bibot.ir/api1/siteverify/
METHOD: POST
POST Parameter
{
 "secret": "کلید مخفی شما",
 "response": "پارامتر دریافتی از بی‌بات"
}

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

{
 "success": true|false,
 "hostname": string, // هاستی که بی‌بات در آن حل شده است
 "challenge_ts": timestamp // زمانی که بی‌بات حل شده است
 "error-codes": [...] // تنها در زمانی که خطایی رخ داده باشد، کد آن در این لیست قرار می‌گیرد و در غیر این صورت این پارامتر ارسال نمی‌شود
}

لیست ارور کدهای ارسالی:

[
 "missing-input-secret", // پارامتر کلید مخفی سایت شما فراموش شده است
 "invalid-input-secret", // پارامتر کلید مخفی سایت شما اشتباه است
 "missing-input-response", // پارامتر ریسپانس شما فراموش شده است
 "invalid-input-response", // پارامتر ریسپانس شما اشتباه است
 "timeout-or-duplicate" // پارامتر ریسپانس منقضی شده است
]