Alibaba Cloud SDK:Integrate Alibaba Cloud SDK V2.0 for PHP

Prerequisites

• PHP 5.6 or later is installed.

• Composer is globally installed. For more information, see the "Globally" section of the Getting Started topic.

composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/

1. Install the SDK for PHP

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 or a Security Token Service (STS) token. For more information, see Credential. 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

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.

<?php

namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi;
use Darabonba\OpenApi\Models\Config;

class Sample {

    /**
     * Use your AccessKey ID and AccessKey secret to initialize a client.
     * @return Dysmsapi Client
     */
    public static function createClient(){
    
        $config = new Config([
            // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured in the code runtime environment. 
            "accessKeyId" => getenv("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" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
        ]);
        $config->endpoint = "dysmsapi.aliyuncs.com";
        return new Dysmsapi($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 parameters.
$sendSmsRequest = new SendSmsRequest([
    "signName" => "<YOUR_VALUE>",
    "templateCode" => "<YOUR_VALUE>",
    "phoneNumbers" => "<YOUR_VALUE>",
]);
// Create a runtime configuration object.
$runtime = new 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.

  <?php
  
  namespace AlibabaCloud\SDK\Sample;
  
  use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi;
  use \Exception;
  use AlibabaCloud\Tea\Exception\TeaError;
  use AlibabaCloud\Tea\Utils\Utils;
  
  use Darabonba\OpenApi\Models\Config;
  use AlibabaCloud\SDK\Dysmsapi\V20170525\Models\SendSmsRequest;
  
  class Sample {
  
      /**
       * Use your AccessKey ID and AccessKey secret to initialize a client.
       * @return Dysmsapi Client
       */
      public static function createClient(){
  
          $config = new Config([
              // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured in the code runtime environment. 
              "accessKeyId" => getenv("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" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
          ]);
          $config->endpoint = "dysmsapi.aliyuncs.com";
          return new Dysmsapi($config);
      }
  
      /**
       * @param string[] $args
       * @return void
       */
      public static function main($args){
          $client = self::createClient();
          // Create a request object and specify parameters.
          $sendSmsRequest = new SendSmsRequest([
              "signName" => "<YOUR_VALUE>",
              "templateCode" => "<YOUR_VALUE>",
              "phoneNumbers" => "<YOUR_VALUE>",
          ]);
          try {
              // Write your own code to display the response of the API operation if necessary.
              $client->sendSms($sendSmsRequest);
          }
          catch (Exception $error) {
              if (!($error instanceof TeaError)) {
                  $error = new TeaError([], $error->getMessage(), $error->getCode(), $error);
              }
              // Handle exceptions with caution in actual business scenarios and never ignore exceptions in your project. In this example, error messages are displayed for reference only. 
              // The error message.
              var_dump($error->message);
              // The information for troubleshooting.
              var_dump($error->data["Recommend"]);
              Utils::assertAsString($error->message);
          }
      }
  }
  $path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
  if (file_exists($path)) {
      require_once $path;
  }
  Sample::main(array_slice($argv, 1));

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

  <?php
  
  namespace AlibabaCloud\SDK\Sample;
  
  use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi;
  use \Exception;
  use AlibabaCloud\Tea\Exception\TeaError;
  use AlibabaCloud\Tea\Utils\Utils;
  
  use Darabonba\OpenApi\Models\Config;
  use AlibabaCloud\SDK\Dysmsapi\V20170525\Models\SendSmsRequest;
  use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
  
  class Sample {
  
      /**
       * Use your AccessKey ID and AccessKey secret to initialize a client.
       * @return Dysmsapi Client
       */
      public static function createClient(){
  
          $config = new Config([
              // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured in the code runtime environment. 
              "accessKeyId" => getenv("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" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
          ]);
          $config->endpoint = "dysmsapi.aliyuncs.com";
          return new Dysmsapi($config);
      }
  
      /**
       * @param string[] $args
       * @return void
       */
      public static function main($args){
          $client = self::createClient();
          // Create a request object and specify parameters.
          $sendSmsRequest = new SendSmsRequest([
              "signName" => "<YOUR_VALUE>",
              "templateCode" => "<YOUR_VALUE>",
              "phoneNumbers" => "<YOUR_VALUE>",
          ]);
          // Create a runtime configuration object.
          $runtime = new RuntimeOptions([]);
          try {
              // Write your own code to display the response of the API operation if necessary.
              $client->sendSmsWithOptions($sendSmsRequest, $runtime);
          }
          catch (Exception $error) {
              if (!($error instanceof TeaError)) {
                  $error = new TeaError([], $error->getMessage(), $error->getCode(), $error);
              }
              // Handle exceptions with caution in actual business scenarios and never ignore exceptions in your project. In this example, error messages are displayed for reference only. 
              // The error message.
              var_dump($error->message);
              // The information for troubleshooting.
              var_dump($error->data["Recommend"]);
              Utils::assertAsString($error->message);
          }
      }
  }
  $path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
  if (file_exists($path)) {
      require_once $path;
  }
  Sample::main(array_slice($argv, 1));

• <API operation>Advance: used for API operations that require file uploading. By default, you must specify runtime parameters. The following sample code shows 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 API (VIAPI).

  composer require alibabacloud/facebody-20191230 4.1.2

  <?php
  
  namespace AlibabaCloud\SDK\Sample;
  
  use AlibabaCloud\SDK\Facebody\V20191230\Facebody;
  use \Exception;
  use AlibabaCloud\Tea\Exception\TeaError;
  use AlibabaCloud\Tea\Utils\Utils;
  
  use Darabonba\OpenApi\Models\Config;
  use AlibabaCloud\SDK\Facebody\V20191230\Models\DetectBodyCountRequest;
  use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
  
  class Sample {
  
      /**
       * Use your AccessKey ID and AccessKey secret to initialize a client.
       * @return Facebody Client
       */
      public static function createClient(){
  
          $config = new Config([
              // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured in the code runtime environment. 
              "accessKeyId" => getenv("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" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
          ]);
          $config->endpoint = "facebody.cn-shanghai.aliyuncs.com";
          return new Facebody($config);
      }
  
      /**
       * @param string[] $args
       * @return void
       */
      public static function main($args){
          $client = self::createClient();
          // Create a request object and specify parameters.
          $detectBodyCountRequest = new DetectBodyCountRequest([
              "imageURL" => "<YOUR_VALUE>"
          ]);
          // Create a runtime configuration object.
          $runtime = new RuntimeOptions([]);
          try {
              // Write your own code to display the response of the API operation if necessary.
              $client->detectBodyCountWithOptions($detectBodyCountRequest, $runtime);
          }
          catch (Exception $error) {
              if (!($error instanceof TeaError)) {
                  $error = new TeaError([], $error->getMessage(), $error->getCode(), $error);
              }
              // Handle exceptions with caution in actual business scenarios and never ignore exceptions in your project. In this example, error messages are displayed for reference only. 
              // The error message.
              var_dump($error->message);
              // The information for troubleshooting.
              var_dump($error->data["Recommend"]);
              Utils::assertAsString($error->message);
          }
      }
  }
  $path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
  if (file_exists($path)) {
      require_once $path;
  }
  Sample::main(array_slice($argv, 1));