google/cloud-recaptcha-enterprise

Google Cloud Recaptcha Enterprise Client for PHP

v1.17.2 2024-12-12 21:15 UTC

Requires

• php: ^8.0
• google/gax: ^1.36.0

Requires (Dev)

• phpunit/phpunit: ^9.0

Suggests

• ext-grpc: Enables use of gRPC, a universal high-performance RPC framework created by Google.
• ext-protobuf: Provides a significant increase in throughput over the pure PHP protobuf implementation. See https://cloud.google.com/php/grpc for installation instructions.

Apache-2.0

README

Idiomatic PHP client for Google Cloud Recaptcha Enterprise.

• API documentation

NOTE: This repository is part of Google Cloud PHP. Any support requests, bug reports, or development contributions should be directed to that project.

Installation

To begin, install the preferred dependency manager for PHP, Composer.

Now install this component:

$ composer require google/cloud-recaptcha-enterprise

This component supports both REST over HTTP/1.1 and gRPC. In order to take advantage of the benefits offered by gRPC (such as streaming methods) please see our gRPC installation guide.

Authentication

Please see our Authentication guide for more information on authenticating your client. Once authenticated, you'll be ready to start making requests.

Sample

require 'vendor/autoload.php';

use Google\Cloud\RecaptchaEnterprise\V1\Key;
use Google\Cloud\RecaptchaEnterprise\V1\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings;
use Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings\IntegrationType;


$client = new RecaptchaEnterpriseServiceClient();
$project = RecaptchaEnterpriseServiceClient::projectName('[MY_PROJECT_ID]');
$webKeySettings = (new WebKeySettings())
    ->setAllowedDomains(['example.com'])
    ->setAllowAmpTraffic(false)
    ->setIntegrationType(IntegrationType::CHECKBOX);
$key = (new Key())
    ->setWebSettings($webKeySettings)
    ->setDisplayName('my sample key')
    ->setName('my_key');

$response = $client->createKey($project, $key);

printf('Created key: %s' . PHP_EOL, $response->getName());

Debugging

Please see our Debugging guide for more information about the debugging tools.

Version

This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in any minor or patch releases. We will address issues and requests with the highest priority.

Next Steps

1. Understand the official documentation.