PHP Server SDK
Официальный серверный SDK на PHP — опубликован как captchala/captchala-php на Packagist.
Три задачи, которые SDK берёт на себя:
- Validate — проверка
pt_pass Token из браузерного SDK. - Issue — выпуск одноразового
sct_server Token для привязки предстоящего запроса к конкретному action / IP / UID. - Moderate — мультимодальная (текст + изображение) модерация контента через тот же OpenAI-совместимый pipeline, что использует панель управления.
Установка
composer require captchala/captchala-phpТребуется PHP ≥ 8.0 с ext-json. Использует cURL при наличии, иначе откатывается на file_get_contents.
Validate (pt_ Token)
use Captchala\Client;
$client = new Client('your_app_key', 'your_app_secret');
$result = $client->validate($_POST['captcha_token']);
if (!$result->isValid()) {
http_response_code(400);
exit($result->getError()); // e.g. "token_expired", "client_ip_mismatch"
}
// Verification passed; proceed with the request.Если вы выпустили исходный server_token с bind_uid, сравните возвращённый uid с пользователем, которого ожидаете:
if ($result->getUid() !== $expectedUserId) {
http_response_code(400);
exit('user mismatch');
}Если вы привязали Token к IP, передайте IP пользователя и на этапе verify:
$client->validate($token, false, $request->ip());Выпуск server Token
Для ответственных потоков (вход, регистрация, оплата) рекомендуемая схема: backend выпускает одноразовый sct_ Token, передаёт его в браузер, браузер передаёт его как prop serverToken. Каждый Token одноразовый, привязан к action и опционально к IP / UID на момент выпуска.
$issue = $client->issueServerToken(
action: 'login',
bindingIp: $request->ip(),
ttl: 300, // seconds; default 300
maxUses: 5, // SDK retry budget
bindUid: $user->id, // pair with ValidateResult::getUid() on verify
);
if (!$issue->isOk()) {
return ['error' => $issue->getError()]; // rate_limit_exceeded, invalid_action, ...
}
return ['server_token' => $issue->getToken()]; // hand to browserМодерация контента
Мультимодальная — принимает смесь текста и URL изображений в формате, совместимом с OpenAI:
$result = $client->moderationCheck([
['type' => 'text', 'text' => $userComment],
['type' => 'image_url', 'image_url' => ['url' => $uploadedImageUrl]],
], userId: $user->id);
if (!$result->isOk()) {
// request error: invalid_credentials, no_content, transport failure, ...
return ['error' => $result->getError()];
}
if ($result->isFlagged()) {
// upstream model flagged; inspect categories for the why
if ($result->hasCategory('violence', 'csam')) {
// hard block
}
}Сокращённый вариант для plain-text:
$result = $client->moderationText('user comment here', userId: $user->id);Категории определяются моделью (например violence, hate, sexual, self-harm); итерируйте getCategories() защитно, а не зашивайте фиксированный набор.
Классы результатов
| Класс | Методы |
|---|---|
ValidateResult | isValid(), getError(), getUid(), getChallengeId(), getAction(), isOffline(), isClientOnly(), getWarning(), toArray() |
IssueResult | isOk(), getToken(), getExpiresIn(), getIssuedAt(), getError(), getMessage(), toArray() |
ModerationResult | isOk(), isFlagged(), hasCategory(...$names), getCategories(), getContentType(), getRaw(), getError(), getMessage(), toArray() |