Google Cloud reCAPTCHA Enterprise: Node.js Client

reCAPTCHA Enterprise API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG .

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained .

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project .
Enable billing for your project .
Enable the Google Cloud reCAPTCHA Enterprise API .
Set up authentication so you can access the API from your local workstation.

Installing the client library

 npm install @google-cloud/recaptcha-enterprise

Using the client library

 /**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The name of the project that contains the keys that will be
 *  listed, in the format "projects/{project}".
 */
// const parent = 'abc123'
/**
 *  Optional. The maximum number of keys to return. Default is 10. Max limit is
 *  1000.
 */
// const pageSize = 1234
/**
 *  Optional. The next_page_token value returned from a previous.
 *  ListKeysRequest, if any.
 */
// const pageToken = 'abc123'

// Imports the Recaptchaenterprise library
const {RecaptchaEnterpriseServiceClient} =
  // eslint-disable-next-line node/no-missing-require
  require(' @google-cloud/recaptcha-enterprise 
').v1;

// Instantiates a client
const recaptchaenterpriseClient = new RecaptchaEnterpriseServiceClient 
();

async function callListKeys() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = await recaptchaenterpriseClient. listKeysAsync 
(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListKeys();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Recaptcha_enterprise_service.add_ip_override	source code
Recaptcha_enterprise_service.annotate_assessment	source code
Recaptcha_enterprise_service.create_assessment	source code
Recaptcha_enterprise_service.create_firewall_policy	source code
Recaptcha_enterprise_service.create_key	source code
Recaptcha_enterprise_service.delete_firewall_policy	source code
Recaptcha_enterprise_service.delete_key	source code
Recaptcha_enterprise_service.get_firewall_policy	source code
Recaptcha_enterprise_service.get_key	source code
Recaptcha_enterprise_service.get_metrics	source code
Recaptcha_enterprise_service.list_firewall_policies	source code
Recaptcha_enterprise_service.list_ip_overrides	source code
Recaptcha_enterprise_service.list_keys	source code
Recaptcha_enterprise_service.list_related_account_group_memberships	source code
Recaptcha_enterprise_service.list_related_account_groups	source code
Recaptcha_enterprise_service.migrate_key	source code
Recaptcha_enterprise_service.remove_ip_override	source code
Recaptcha_enterprise_service.reorder_firewall_policies	source code
Recaptcha_enterprise_service.retrieve_legacy_secret_key	source code
Recaptcha_enterprise_service.search_related_account_group_memberships	source code
Recaptcha_enterprise_service.update_firewall_policy	source code
Recaptcha_enterprise_service.update_key	source code
Recaptcha_enterprise_service_v1_beta1.annotate_assessment	source code
Recaptcha_enterprise_service_v1_beta1.create_assessment	source code
Recaptcha_enterprise_service_v1_beta1.create_key	source code
Recaptcha_enterprise_service_v1_beta1.delete_key	source code
Recaptcha_enterprise_service_v1_beta1.get_key	source code
Recaptcha_enterprise_service_v1_beta1.list_keys	source code
Recaptcha_enterprise_service_v1_beta1.update_key	source code
Quickstart	source code

The Google Cloud reCAPTCHA Enterprise Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule . Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

Legacy versions are not tested in continuous integration.
Some security patches and features cannot be backported.
Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags . The dist-tags follow the naming convention legacy-(version) . For example, npm install @google-cloud/recaptcha-enterprise@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stablelibraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide .

Please note that this README.md , the samples/README.md , and a variety of configuration files in this repository (including .nycrc and tsconfig.json ) are generated from a central template. To edit one of these files, make an edit to its templates in directory .

License

Apache Version 2.0

See LICENSE