Alibaba Cloud SDK:Integrate Alibaba Cloud SDK V2.0 for Node.js

Prerequisites

The version of Node.js to be installed is 8.x or later.

1. Install the SDK for Node.js

Alibaba Cloud SDK allows you to make generic and specialized calls. For more information, see Generic calls and specialized calls. The SDK that you need to install varies based on the call type.

npm i @alicloud/openapi-client

2. Configure an access credential

To call API operations of an Alibaba Cloud service, you must configure an access credential, such as an AccessKey pair. For more information, see the "Credential" section of the Identity, credential, and authorization topic. To prevent AccessKey pair leaks, you can record the AccessKey pair in environment variables. For more information about other security solutions, see Credential security solutions. In this example, the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are configured.

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'LTAI4GDty8ab9W4Y1D****', [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'IrVTNZNy5yQelTETg0cZML3TQn****', [System.EnvironmentVariableTarget]::User)

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'LTAI4GDty8ab9W4Y1D****', [System.EnvironmentVariableTarget]::Machine)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'IrVTNZNy5yQelTETg0cZML3TQn****', [System.EnvironmentVariableTarget]::Machine)

$env:ALIBABA_CLOUD_ACCESS_KEY_ID = "LTAI4GDty8ab9W4Y1D****"
$env:ALIBABA_CLOUD_ACCESS_KEY_SECRET = "IrVTNZNy5yQelTETg0cZML3TQn****"

3. Call an API operation

In this example, a specialized call is made. For more information about how to make a generic call, see Generic calls.

3.1 Initialize a request client

You can use multiple methods to initialize a request client. For more information, see Manage access credentials. In this example, an AccessKey pair is used to initialize a request client.

import Dysmsapi20180501, * as $Dysmsapi20180501 from '@alicloud/dysmsapi20180501';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import Util, * as $Util from '@alicloud/tea-util';

export default class Client {

  static createClient(): Dysmsapi20180501 {
    let config = new $OpenApi.Config({
      // Required, please ensure that the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID is set.
      accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
      // Required, please ensure that the environment variables ALIBABA_CLOUD_ACCESS_KEY_SECRET is set.
      accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
    });
    // See https://api.alibabacloud.com/product/Dysmsapi.
    config.endpoint = `dysmsapi.aliyuncs.com`;
    return new Dysmsapi20180501(config);
  }
}

const Dysmsapi20180501 = require('@alicloud/dysmsapi20180501');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Tea = require('@alicloud/tea-typescript');

class Client {

  static createClient() {
    let config = new OpenApi.Config({
      // Required, please ensure that the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID is set.
      accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
      // Required, please ensure that the environment variables ALIBABA_CLOUD_ACCESS_KEY_SECRET is set.
      accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
    });
    // See https://api.alibabacloud.com/product/Dysmsapi.
    config.endpoint = `dysmsapi.aliyuncs.com`;
    return new Dysmsapi20180501.default(config);
  }
}

3.2 Create a request object and configure runtime configurations

In most cases, you can create a request object and specify the parameters based on your business requirements. You can also customize runtime configurations.

// Create a request object and specify the parameters.
let sendMessageToGlobeRequest = new Dysmsapi20180501.SendMessageToGlobeRequest({
    to: '<YOUR_VALUE>',
    from: '<YOUR_VALUE>',
    message: '<YOUR_VALUE>',
});
// Create a runtime configuration object.
let runtime = new Util.RuntimeOptions({});

3.3 Initiate an API request

In Alibaba Cloud SDK V2.0, the client of each Alibaba Cloud service contains all the API operations provided by the service. In addition, Alibaba Cloud SDK V2.0 provides three methods to define each API operation. This design aims to improve the flexibility and efficiency of development, and ensure that developers can call API operations in an optimal way based on their project requirements.

• <API operation>: uses the default runtime configurations to initiate a request. You do not need to specify runtime parameters.

  TypeScript

  import Dysmsapi20180501, * as $Dysmsapi20180501 from '@alicloud/dysmsapi20180501';
  import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
  import Util, * as $Util from '@alicloud/tea-util';
  
  export default class Client {
  
    static createClient(): Dysmsapi20180501 {
      let config = new $OpenApi.Config({
        // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured in the code runtime environment. 
        accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
        // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is configured in the code runtime environment. 
        accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
      });
      // The endpoint of SMS. For more information, visit https://api.alibabacloud.com/product/Dysmsapi.
      config.endpoint = `dysmsapi.aliyuncs.com`;
      return new Dysmsapi20180501(config);
    }
  
    static async main(): Promise<void> {
      let client = Client.createClient();
      // Create a request object and specify parameters.
      let sendMessageToGlobeRequest = new $Dysmsapi20180501.SendMessageToGlobeRequest({
        to: "<YOUR_VALUE>",
        from: "<YOUR_VALUE>",
        message: "<YOUR_VALUE>",
      });
      try {
        // Initiate the request.  
        await client.sendMessageToGlobe(sendMessageToGlobeRequest);
      } catch (error) {
        // Handle exceptions with caution in your actual business scenario and do not ignore exceptions in your project. In this example, error messages are printed for reference only. 
        // Return error messages.
        console.log(error.message);
        // The URL of the corresponding error diagnostics.
        console.log(error.data["Recommend"]);
      }    
    }
  }
  
  Client.main();
  

  JavaScript

  const Dysmsapi20180501 = require('@alicloud/dysmsapi20180501');
  const OpenApi = require('@alicloud/openapi-client');
  const Util = require('@alicloud/tea-util');
  
  class Client {
  
    static createClient() {
      let config = new OpenApi.Config({
        // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured in the code runtime environment. 
        accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
        // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is configured in the code runtime environment. 
        accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
      });
      // The endpoint of SMS. For more information, visit https://api.alibabacloud.com/product/Dysmsapi.
      config.endpoint = `dysmsapi.aliyuncs.com`;
      return new Dysmsapi20180501.default(config);
    }
  
    static async main() {
      // Create a request object and specify parameters.
      let client = Client.createClient();
      let sendMessageToGlobeRequest = new Dysmsapi20180501.SendMessageToGlobeRequest({
        to: '<YOUR_VALUE>',
        from: '<YOUR_VALUE>',
        message: '<YOUR_VALUE>',
      });
      try {
        // Initiate the request.
        await client.sendMessageToGlobe(sendMessageToGlobeRequest);
      } catch (error) {
        // Handle exceptions with caution in your actual business scenario and do not ignore exceptions in your project. In this example, error messages are printed for reference only. 
        // Return error messages.
        console.log(error.message);
        // The URL of the corresponding error diagnostics.
        console.log(error.data["Recommend"]);
        Util.default.assertAsString(error.message);
      }    
    }
  }
  
  exports.Client = Client;
  Client.main();
  

• <API operation>WithOptions: uses the custom runtime configurations to initiate a request. For more information, see Advanced configuration.

  TypeScript

  import Dysmsapi20180501, * as $Dysmsapi20180501 from '@alicloud/dysmsapi20180501';
  import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
  import Util, * as $Util from '@alicloud/tea-util';
  
  export default class Client {
  
    static createClient(): Dysmsapi20180501 {
      let config = new $OpenApi.Config({
        // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured in the code runtime environment. 
        accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
        // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is configured in the code runtime environment. 
        accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
      });
      // The endpoint of SMS. For more information, visit https://api.alibabacloud.com/product/Dysmsapi.
      config.endpoint = `dysmsapi.aliyuncs.com`;
      return new Dysmsapi20180501(config);
    }
  
    static async main(): Promise<void> {
      let client = Client.createClient();
      // Create a request object and specify parameters.
      let sendMessageToGlobeRequest = new $Dysmsapi20180501.SendMessageToGlobeRequest({
        to: "<YOUR_VALUE>",
        from: "<YOUR_VALUE>",
        message: "<YOUR_VALUE>",
      });
      // Create a runtime configuration object.
      let runtime = new $Util.RuntimeOptions({ });
      try {
        // Initiate the request.  
        await client.sendMessageToGlobeWithOptions(sendMessageToGlobeRequest, runtime);
      } catch (error) {
        // Handle exceptions with caution in your actual business scenario and do not ignore exceptions in your project. In this example, error messages are printed for reference only. 
        // Return error messages.
        console.log(error.message);
        // The URL of the corresponding error diagnostics.
        console.log(error.data["Recommend"]);
      }    
    }
  }
  
  Client.main();
  

  JavaScript

  const Dysmsapi20180501 = require('@alicloud/dysmsapi20180501');
  const OpenApi = require('@alicloud/openapi-client');
  const Util = require('@alicloud/tea-util');
  
  class Client {
  
    static createClient() {
      let config = new OpenApi.Config({
        // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured in the code runtime environment. 
        accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
        // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is configured in the code runtime environment. 
        accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
      });
      // The endpoint of SMS. For more information, visit https://api.alibabacloud.com/product/Dysmsapi.
      config.endpoint = `dysmsapi.aliyuncs.com`;
      return new Dysmsapi20180501.default(config);
    }
  
    static async main() {
      // Create a request object and specify parameters.
      let client = Client.createClient();
      let sendMessageToGlobeRequest = new Dysmsapi20180501.SendMessageToGlobeRequest({
        to: '<YOUR_VALUE>',
        from: '<YOUR_VALUE>',
        message: '<YOUR_VALUE>',
      });
      // Create a runtime configuration object.
      let runtime = new Util.RuntimeOptions({ });
      try {
        // Initiate the request.
        await client.sendMessageToGlobeWithOptions(sendMessageToGlobeRequest, runtime);
      } catch (error) {
        // Handle exceptions with caution in your actual business scenario and do not ignore exceptions in your project. In this example, error messages are printed for reference only. 
        // Return error messages.
        console.log(error.message);
        // The URL of the corresponding error diagnostics.
        console.log(error.data["Recommend"]);
        Util.default.assertAsString(error.message);
      }    
    }
  }
  
  exports.Client = Client;
  Client.main();
  

• <API operation>Advance: used for API operations that require file uploading. By default, you must specify runtime parameters. The following sample code provides examples on how to initiate a request to upload a file and call an API operation to use the human face and body recognition feature of Vision Intelligent Application Programming Interface Platform (VIAPI).

  // The dependency for the human face and body recognition feature.
  npm install @alicloud/facebody20191230@4.0.8

  TypeScript

  import Facebody20191230, * as $Facebody20191230 from '@alicloud/facebody20191230';
  import * as $OpenApi from '@alicloud/openapi-client';
  import * as $Util from '@alicloud/tea-util';
  import {createReadStream} from 'fs';
  import Credential from '@alicloud/credentials';
  
  export default class Client {
    static async main(): Promise<void> {
      // Use the default credential to initialize a Credentials client.
      const credentialClient = new Credential();
      const facebodyConfig = new $OpenApi.Config({
        // Use the SDK Credentials package to configure a credential.
        credential: credentialClient,
        // Specify the region in which you want to access the human face and body recognition feature. Only the China (Shanghai) region is supported by the feature.
        regionId: 'cn-shanghai',
      });
      const facebodyClient = new Facebody20191230(facebodyConfig);
      const request = new $Facebody20191230.DetectBodyCountAdvanceRequest({
        imageURLObject: createReadStream('<YOUR-FILE-PATH>'),
      });
      // Construct the runtime configuration object and specify runtime parameters. 
      const runtime = new $Util.RuntimeOptions({});
      const resp = await facebodyClient.DetectBodyCountAdvance(request, runtime);
      console.log(resp.headers);
      console.log(resp.body);
    }
  }
  

  JavaScript

  const { default: Facebody20191230, DetectBodyCountAdvanceRequest } = require('@alicloud/facebody20191230');
  const { Config } = require('@alicloud/openapi-client');
  const { RuntimeOptions } = require('@alicloud/tea-util');
  const { createReadStream } = require('fs');
  const { default: Credential } = require('@alicloud/credentials')
  
  async function main() {
    const facebodyConfig = new Config({
      credential: new Credential(),
      // Specify the region in which you want to access the human face and body recognition feature. Only the China (Shanghai) region is supported by the feature.
      regionId: 'cn-shanghai'
    });
    const facebodyClient = new Facebody20191230(facebodyConfig);
    const request = new DetectBodyCountAdvanceRequest({
      imageURLObject: createReadStream('<YOUR-FILE-PATH>'),
    });
    // Construct the runtime configuration object and specify runtime parameters. 
    const runtime = new RuntimeOptions({});
    const resp = await facebodyClient.detectBodyCountAdvance(request, runtime);
    console.log(resp.headers);
    console.log(resp.body);
  }
  main();