Подключиться
Yandex SmartCaptcha

Как начать работать с Yandex SmartCaptcha

Статья создана

Чтобы начать работу с сервисом:

  1. Создайте капчу.
  2. Получите ключи.
  3. Добавьте виджет на страницу.
  4. Проверьте ответ пользователя.

Перед началом работы

  1. Перейдите в консоль управления. Войдите в Yandex Cloud или зарегистрируйтесь, если вы еще не зарегистрированы.
  2. На странице биллинга убедитесь, что у вас подключен платежный аккаунт, и он находится в статусе ACTIVE или TRIAL_ACTIVE. Если платежного аккаунта нет, создайте его.

Создайте капчу

  1. В консоли управления выберите каталог.
  2. Выберите сервис Yandex SmartCaptcha.
  3. Нажмите кнопку Создать капчу.
  4. Введите имя капчи.
  5. Выберите сложность Medium.
  6. Укажите список сайтов, на которых будет размещаться капча.
  7. Типа конфигурации оставьте стандартным.
  8. Нажмите кнопку Создать.

Получите ключи капчи

  1. В консоли управления выберите каталог.
  2. Выберите сервис Yandex SmartCaptcha.
  3. Нажмите на имя капчи или создайте новую капчу.
  4. На вкладке Обзор скопируйте ключ_клиента и ключ_сервера.

С помощью ключа клиента вы можете добавить виджет SmartCaptcha на свою страницу. Ключ сервера потребуется для проверки ответа пользователя.

Добавьте виджет на страницу

Добавьте виджет автоматическим методом:

  1. Подключите JS-скрипт к странице пользователя. Для этого разместите в любом месте страницы (например, внутри тега <head>) код:

    <script src="https://captcha-api.yandex.ru/captcha.js" defer></script>

    Скрипт captcha.js автоматически найдет все div с классом smart-captcha и установит в них виджет.

  2. Добавьте на страницу пустой контейнер (элемент div), чтобы скрипт captcha.js загрузил в него виджет:

    <div
    id="captcha-container"
    class="smart-captcha"
    data-sitekey="<ключ_клиента>"
></div>

    Примечание

    При загрузке виджет меняет высоту контейнера, в котором он находится, на 100px. Это может привести к нежелательному «скачку» верстки на странице из-за изменения высоты. Чтобы избавиться от этого «скачка», вы можете задать до загрузки виджета высоту контейнера 100px.

    <div ... style="height: 100px"></div>

На странице отобразится кнопка Я не робот. Сервис проверит запрос пользователя, когда он нажмет кнопку. Если запрос покажется подозрительным, сервис предложит пользователю решить задание.

Проверьте ответ пользователя

После проверки пользователю выдается уникальный токен. Токен загружается в элемент <input type="hidden" name="smart-token" value="<токен>" внутри контейнера с виджетом. Например, так:

<div id="captcha-container" class="smart-captcha" ...>
    <input type="hidden" name="smart-token" value="<токен>">
    ...
</div>

Для проверки токена нужно отправить GET-запрос на адрес https://captcha-api.yandex.ru/validate со следующими параметрами:

  • secret — ключ для серверной части;
  • token — токен, полученный после прохождения проверки;
  • ip — IP-адрес пользователя, от которого пришел запрос на проверку токена.

Пример функции проверки токена:

const https = require('https'),
    querystring = require('querystring');

const SMARTCAPTCHA_SERVER_KEY = "<ключ_сервера>";


function check_captcha(token, callback) {
    const options = {
        hostname: 'captcha-api.yandex.ru',
        port: 443,
        path: '/validate?' + querystring.stringify({
            secret: SMARTCAPTCHA_SERVER_KEY,
            token: token,
            ip: '<IP-адрес_пользователя>', // Способ получения IP-адреса пользователя зависит от вашего фреймворка и прокси.
        }),
        method: 'GET',
    };
    const req = https.request(options, (res) => {
        res.on('data', (content) => {
            if (res.statusCode !== 200) {
                console.error(`Allow access due to an error: code=${res.statusCode}; message=${content}`);
                callback(true);
                return;
            }
            callback(JSON.parse(content).status === 'ok');
        });
    });
    req.on('error', (error) => {
        console.error(error);
        callback(true);
    });
    req.end();
}


let token = "<token>";
check_captcha(token, (passed) => {
    if (passed) {
        console.log("Passed");
    } else {
        console.log("Robot");
    }
});

define('SMARTCAPTCHA_SERVER_KEY', '<ключ_сервера>');

function check_captcha($token) {
    $ch = curl_init();
    $args = http_build_query([
        "secret" => SMARTCAPTCHA_SERVER_KEY,
        "token" => $token,
        "ip" => $_SERVER['REMOTE_ADDR'], // Нужно передать IP-адрес пользователя.
                                         // Способ получения IP-адреса пользователя зависит от вашего прокси.
    ]);
    curl_setopt($ch, CURLOPT_URL, "https://captcha-api.yandex.ru/validate?$args");
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_TIMEOUT, 1);

    $server_output = curl_exec($ch);
    $httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    if ($httpcode !== 200) {
        echo "Allow access due to an error: code=$httpcode; message=$server_output\n";
        return true;
    }
    $resp = json_decode($server_output);
    return $resp->status === "ok";
}

$token = $_POST['smart-token'];
if (check_captcha($token)) {
    echo "Passed\n";
} else {
    echo "Robot\n";
}

import requests
import sys
import json


SMARTCAPTCHA_SERVER_KEY = "<ключ_сервера>"


def check_captcha(token):
    resp = requests.get(
        "https://captcha-api.yandex.ru/validate",
        {
            "secret": SMARTCAPTCHA_SERVER_KEY,
            "token": token,
            "ip": "<IP-адрес_пользователя>"  # Способ получения IP-адреса зависит от вашего фреймворка и прокси.                                   
                                             # Например, в Flask это может быть request.remote_addr
        },
        timeout=1
    )
    server_output = resp.content.decode()
    if resp.status_code != 200:
        print(f"Allow access due to an error: code={resp.status_code}; message={server_output}", file=sys.stderr)
        return True
    return json.loads(server_output)["status"] == "ok"
token = "<token>"  # Например, request.form["smart-token"]
if check_captcha(token):
    print("Passed")
else:
    print("Robot")

Что дальше

В этой статье: