Web Risk API: Node.js Client

Web Risk API client for Node.js

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

• Web Risk API Node.js Client API Reference
• Web Risk API Documentation
• github.com/googleapis/nodejs-web-risk

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Web Risk API API.
4. Set up authentication with a service account so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/web-risk

Using the client library

/** * Check a URI against the WebRisk API. * @param {string} uri A URI to pass to the Web Risk API. */async function quickstart(uri) {  // Create the WebRisk client library.  const {WebRiskServiceClient} = require('@google-cloud/web-risk');  const client = newWebRiskServiceClient();  // Create an API request to check for malware, social engineering,  // and unwanted software.  const request = {    uri: uri,    threatTypes: ['MALWARE', 'SOCIAL_ENGINEERING', 'UNWANTED_SOFTWARE'],  };  // call the WebRisk searchUris API.  const {threat} = (await client.searchUris(request))[0];  if (threat) {    console.info(threat);  } else {    console.info('no threats found');  }}

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

Sample	Source Code	Try it
Quickstart	source code

TheWeb Risk API Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.

Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed via npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).

Legacy Node.js versions are supported as a best effort:

• Legacy versions will not be tested in continuous integration.
• Some security patches may not be able to be backported.
• Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

• legacy-8: install client libraries from this dist-tag for versionscompatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to beGeneral Availability (GA). This means itis stable; the code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againstGA librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE