Alibaba Cloud SDK:Integrate Alibaba Cloud Darabonba SDK for PHP

Prerequisites

• PHP 5.6 or later is installed.

• Composer is installed globally. For more information, see Globally.

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

Step 2: Import the SDK to your project

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

Specialized calls

You can visit OpenAPI Explorer, find the service that you want to use, and view the supported languages and installation methods. Then, import the SDK of the service to your project. In this example, SMS SDK is imported. Perform the following steps:

1. Visit the SMS SDK page.

2. In the All languages section, select the language that you want to use.

3. In the Installation Method section, select an installation method and copy the installation code.

4. Add the dependency to your project.

Run the following command to install SMS SDK for PHP:

composer require alibabacloud/dysmsapi-20170525 2.0.23

Generic calls

You do not need to install the SDK of a service to make generic calls. You need to only import the Darabonba\OpenApi core package. For information about the latest version of the core package, see alibabacloud/darabonba-openapi. Run the following command to install the core package:

composer require alibabacloud/darabonba-openapi

Step 3: Call an API operation

Download the sample code. For more information, see Get started with Alibaba Cloud Darabonba SDK for PHP. In this example, the sample code of a specialized call is used. If you want to make a generic call, turn on Common Request when you download the sample code. For more information, see Generic calls and specialized calls.

Initialize a request client

Method 1: Use an AccessKey pair

<?php
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi as DysmsAPI;

public static function createClient(){
	$config = new Config([
		// Required. Specify your AccessKey ID.
		"accessKeyId" => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
		// Required. Specify your AccessKey secret.
		"accessKeySecret" => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
	]);
	// Specify the endpoint. For more information, visit https://api.aliyun.com/product/Dysmsapi.
	$config->endpoint = "dysmsapi.aliyuncs.com";
	// Initialize a request client for a specialized call.
	$dysmsApiClient = new DysmsAPI($config);
}

Method 2: Use an STS token

<?php
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi as DysmsAPI;

public static function createClient(){
	$config = new Config([
		// Required. Specify your AccessKey ID.
		"accessKeyId" => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
		// Required. Specify your AccessKey secret.
		"accessKeySecret" => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
		// Required. Specify your Security Token Service (STS) token.
		"securityToken" => getenv('ALIBABA_CLOUD_SECURITY_TOKEN')
	]);
	// Specify the endpoint. For more information, visit https://api.aliyun.com/product/Dysmsapi.
	$config->endpoint = "dysmsapi.aliyuncs.com";
	// Initialize a request client for a specialized call.
	$dysmsApiClient = new DysmsAPI($config);
}

Method 3: Use the Credentials tool

<?php

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi as DysmsAPI;

// Use the default credential to initialize a Credentials client. 
$credential = new Credential([]);
$config = new Config([
	// Use the SDK Credentials package to configure a credential.
	'credential'        => $credential,
]);
// To call the SMS API, initialize the Client class of the SDK package for SMS.
$config->endpoint = 'dysmsapi.aliyuncs.com';
// Initialize the Client class of the SDK package for SMS.
$dysmsApiClient = new DysmsAPI($config);

Create a request object or a runtime configuration object

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.
$sendSmsRequest = new SendSmsRequest([
"phoneNumbers" => "<YOUR_VALUE>",
"signName" => "<YOUR_VALUE>"
]);
// Create a runtime configuration object.
$runtime = new RuntimeOptions([]);

Initiate a request

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

  <?php
  
  use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi;
  use AlibabaCloud\SDK\Dysmsapi\V20170525\Models\SendSmsRequest;
  use Darabonba\OpenApi\Models\Config;
  use AlibabaCloud\Credentials\Credential;
  
  // Enable autoloading for Composer by using the vendor/autoload.php file.
  require_once('../vendor/autoload.php');
  
  // Use the default credential to initialize a Credentials client. 
  $credentialClient = new Credential([]);
  $smsConfig = new Config([
      // Use the SDK Credentials package to configure a credential.
      'credential' => $credentialClient,
      // Specify the endpoint of the cloud service.
      'endpoint' => 'ecs.aliyuncs.com'
  ]);
  $smsClient = new Dysmsapi($smsConfig);
  // Construct the request object.
  $sendSmsRequest = new SendSmsRequest([]);
  // Obtain the response object.
  $response = $smsClient->sendSms($sendSmsRequest);
  var_dump($response);

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

  <?php
  
  use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi;
  use AlibabaCloud\SDK\Dysmsapi\V20170525\Models\SendSmsRequest;
  use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
  use Darabonba\OpenApi\Models\Config;
  use AlibabaCloud\Credentials\Credential;
  
  // Enable autoloading for Composer by using the vendor/autoload.php file.
  require_once('../vendor/autoload.php');
  
  // Use the default credential to initialize a Credentials client. 
  $credentialClient = new Credential([]);
  $smsConfig = new Config([
      // Use the SDK Credentials package to configure a credential.
      'credential' => $credentialClient,
      // Specify the endpoint of the cloud service.
      'endpoint' => 'ecs.aliyuncs.com'
  ]);
  $smsClient = new Dysmsapi($smsConfig);
  // Construct the request object.
  $sendSmsRequest = new SendSmsRequest([]);
  $runtime = new RuntimeOptions();
  // Specify whether to automatically retry a request.
  $runtime->autoretry = true;
  // Set the timeout period for connection requests.
  $runtime->connectTimeout = 10000;
  // Set the timeout period for read requests.
  $runtime->readTimeout    = 10000;
  // Obtain the response object.
  $response = $smsClient->sendSmsWithOptions($sendSmsRequest,$runtime);
  var_dump($response);

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

  <?php
  
  use Darabonba\OpenApi\Models\Config;
  use GuzzleHttp\Psr7\Stream;
  use AlibabaCloud\Credentials\Credential;
  use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
  use AlibabaCloud\Tea\Exception\TeaError;
  use AlibabaCloud\SDK\Facebody\V20191230\Facebody;
  use AlibabaCloud\SDK\Facebody\V20191230\Models\DetectBodyCountAdvanceRequest;
  
  // Enable autoloading for Composer by using the vendor/autoload.php file.
  require_once('../vendor/autoload.php');
  
  $credentialClient = new Credential([]);
  $facebodyConfig = new Config([
      // Use the SDK Credentials package to configure a credential.
      'credential' => $credentialClient,
      // Specify the endpoint of the cloud service.
      'endpoint' => 'facebody.cn-shanghai.aliyuncs.com'
  ]);
  
  $request = new DetectBodyCountAdvanceRequest();
  // Read the file and configure the file stream for the SDK request object.
  $request->imageURLObject = new Stream(fopen("<filepath>", "rb"));
  
  $runtime = new RuntimeOptions();
  $facebodyClient = new Facebody($facebodyConfig);
  
  try {
      // Upload the file by using the method for uploading local files.
      $response = $facebodyClient->detectBodyCountAdvance($request, $runtime);
      var_dump($response);
  } catch (TeaError $e) {
      var_dump($e->getMessage());
      var_dump($e->getErrorInfo());
      var_dump($e->getLastException());
      var_dump($e->getLastRequest());
  }