پرش به مطلب اصلی
نسخه: 1.0.0

تأیید کنید

توضیحات: بررسی کنید که کاربر چالش را به درستی حل کرده است.

روش: POST.

نقطه پایانی : https://api.arcaptcha.co/arcaptcha/api/verify

درخواست پارامترها:

پارامترهاتوضیحات
challenge_idضروری. نام فیلد که از فرم خود دریافت کردید
site_keyضروری. کلید سایتی که انتظار دارید ببینید.
secret_keyضروری. کلید مخفی حساب شما

مهم: لطفا دقت کنید نوع درخواست شما از جنس JSON باشد. به این منظور بایستی مقدار هدر Content-Type در درخواست شما application/json ست شده باشد

بدنه پاسخ :

پارامترهاتوضیحات
successوضعیت چالش می تواند درست یا نادرست باشد
error-codes(اختیاری)توضیحات خلاصه در مورد خطاهای احتمالی

مثال(NodeJS) :

const arcaptcha_api = "https://api.arcaptcha.co/arcaptcha/api/verify";

const result = await axios.post(arcaptcha_api, {
challenge_id: req.body["arcaptcha-token"],
site_key: "SITE_KEY",
secret_key: "SECRET_KEY",
});
if (result.data.success) {
// its OK
} else {
// throw Error
}

مرجع کد خطا

Error codeDescription
missing-input-sitekeyپارامتر site_key وجود ندارد
missing-input-secretپارامتر secret_key وجود ندارد
missing-input-responseپارامتر challenge_id وجود ندارد
bad-requestدرخواست نامعتبر و یا دستکاری شده‌است
invalid-input-sitekeyپارامتر site_key نامعتبر و یا دستکاری شده‌است.
invalid-input-secretپارامتر secret_key نامعتبر و یا دستکاری شده‌است.
invalid-input-responseپارامتر challenge_id نامعتبر و یا دستکاری شده‌است.
timeout-or-duplicateپاسخ چالش معتبر نیست: یا منقضی شده و یا قبلا استفاده شده است.