Google Cloud Recaptcha Enterprise for PHP

Idiomatic PHP client for Google Cloud Recaptcha Enterprise .

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\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\CreateKeyRequest;
use Google\Cloud\RecaptchaEnterprise\V1\Key;
use Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings;
use Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings\IntegrationType;

$formattedParent = RecaptchaEnterpriseServiceClient::projectName('[PROJECT]');
$keyDisplayName = '[DISPLAY_NAME]';

// Create a client.
$recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

// Prepare the request message.
$webKeySettings = (new WebKeySettings())
    ->setAllowedDomains(['example.com'])
    ->setAllowAmpTraffic(false)
    ->setIntegrationType(IntegrationType::CHECKBOX);
$key = (new Key())
    ->setWebSettings($webKeySettings)
    ->setDisplayName($keyDisplayName)
    ->setName('my_key');
$request = (new CreateKeyRequest())
    ->setParent($formattedParent)
    ->setKey($key);

// Call the API and handle any network failures.
try {
    /** @var Key $response */
    $response = $recaptchaEnterpriseServiceClient->createKey($request);
    printf('Created key: %s' . PHP_EOL, $response->getName());
} catch (ApiException $ex) {
    printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}

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

Understand the official documentation .