快速使用新版SDK初始化用戶端進行OpenAPI請求（PHP SDK） - Alibaba Cloud SDK

整合阿里雲SDK主要有三步：引入阿里雲SDK、設定訪問憑據、編寫調用代碼。本文將以PHP語言調用Short Message Service (SMS)的傳送簡訊介面為例，講解完整的整合步驟。

環境要求

PHP版本 >= 5.6。
必須在系統上全域安裝 Composer。

重要

執行 composer 安裝 SDK 的 PHP 版本要小於或等於實際運行時的 PHP 版本。例如，在 PHP7.2 環境下安裝 SDK 後產生 vendor 目錄，只能在 PHP7.2 以上版本使用，如果拷貝到 PHP5.6 環境下使用，會出現依賴版本不相容問題。一些使用者可能由於網路問題無法安裝，可以通過以下命令使用阿里雲 Composer 全量鏡像。

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

1. 引入SDK

登入SDK Center，選擇將要使用產品，例如您將要調用Short Message Service (SMS)的API。
在安裝頁面，所有語言選擇PHP。然後在快速入門頁簽中，您可以擷取Short Message Service (SMS)的SDK安裝方式。

2. 設定訪問憑據

調用阿里雲OpenAPI通常需要設定訪問憑據，常見憑據類型為AccessKey（簡稱：AK）和臨時安全性權杖STS Token，詳情請參見憑據。為防止憑據泄露，常用的方案是將其儲存到環境變數中，更多安全方案請參見憑據的安全使用方式情節。本文以設定環境變數ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET為例：

Linux和macOS系統配置方法

通過export命令配置環境變數

重要

使用export命令配置的臨時環境變數僅當前會話有效，當會話退出之後所設定的環境變數將會丟失。若需長期保留環境變數，可將export命令配置到對應作業系統的啟動設定檔中。

配置AccessKey ID並按斷行符號。

# 將<ACCESS_KEY_ID>替換為您自己的AccessKey ID。
export ALIBABA_CLOUD_ACCESS_KEY_ID=<ACCESS_KEY_ID>

配置AccessKey Secret並斷行符號。

# 將<ACCESS_KEY_SECRET>替換為您自己的AccessKey Secret。
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<ACCESS_KEY_SECRET>

驗證是否配置成功。
執行echo $ALIBABA_CLOUD_ACCESS_KEY_ID命令，如果返回正確的AccessKey ID，則說明配置成功。

Windows系統配置方法

通過圖形化使用者介面GUI

操作步驟

以下為Windows 10中通過圖形化使用者介面設定環境變數的步驟。

在案頭按右鍵此電腦，選擇屬性>進階系統設定>環境變數>系統變數/使用者變數>建立，完成以下配置：

變數	樣本值
AccessKey ID	變數名：ALIBABA_CLOUD_ACCESS_KEY_ID 變數值：LTAI4GDty8ab9W4Y1D****
AccessKey Secret	變數名：ALIBABA_CLOUD_ACCESS_KEY_SECRET 變數值：IrVTNZNy5yQelTETg0cZML3TQn****

測試設定是否成功
單擊開始（或快速鍵：Win+R）> 運行（輸入 cmd）> 確定（或按 Enter 鍵），開啟命令提示字元，執行echo %ALIBABA_CLOUD_ACCESS_KEY_ID%、echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%命令。若返回正確的AccessKey，則說明配置成功。

通過命令列提示符CMD

操作步驟
以管理員身份開啟命令提示字元，並使用以下命令在系統中新增環境變數。
```
setx ALIBABA_CLOUD_ACCESS_KEY_ID LTAI4GDty8ab9W4Y1D**** /M
setx ALIBABA_CLOUD_ACCESS_KEY_SECRET IrVTNZNy5yQelTETg0cZML3TQn**** /M
```
其中/M表示系統級環境變數，設定使用者級環境變數時可以不攜帶該參數。
測試設定是否成功
單擊開始（或快速鍵：Win+R）> 運行（輸入 cmd）> 確定（或按 Enter 鍵），開啟命令提示字元，執行echo %ALIBABA_CLOUD_ACCESS_KEY_ID%、echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%命令。若返回正確的AccessKey，則說明配置成功。

通過Windows PowerShell

在PowerShell中，設定新的環境變數（對所有新會話都有效）：

[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****"

在PowerShell中，執行Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_ID、Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET命令。若返回正確的AccessKey，則說明配置成功。

3. 調用OpenAPI

3.1 初始化請求用戶端

初始化請求用戶端有多種方式，這裡以使用AK初始化為例，更多初始化方式，請參見管理訪問憑據。

<?php

namespace AlibabaCloud\SDK\Sample;

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

class Sample {

    /**
     * 使用AK&SK初始化帳號Client
     * @return Dysmsapi Client
     */
    public static function createClient(){
    
        $config = new Config([
            // 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID。
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            // 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
            "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
        ]);
        $config->endpoint = "dysmsapi.aliyuncs.com";
        return new Dysmsapi($config);
    }
}

3.2 建立請求對象&運行時配置

通常您需要根據業務的實際需要傳入參數，您也可自訂運行時配置。

// 建立請求對象並設定入參
$sendSmsRequest = new SendSmsRequest([
    "signName" => "<YOUR_VALUE>",
    "templateCode" => "<YOUR_VALUE>",
    "phoneNumbers" => "<YOUR_VALUE>",
]);
// 建立運行時設定物件
$runtime = new RuntimeOptions([]);

3.3 發起請求

在V2.0 SDK中，每個產品的用戶端包含了該產品所提供的所有OpenAPI。此外，對於每一個OpenAPI，SDK提供了三種介面定義方式。這樣的設計旨在提升開發靈活性與效率，確保開發人員能夠以最符合自身專案需求的方式調用API。

說明

介面名稱為OpenAPI名稱首字母小寫。

<介面名稱>：使用預設的運行時配置發起介面調用，可以不用傳入運行參數的要求方法。

<?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 {

    /**
     * 使用AK&SK初始化帳號Client
     * @return Dysmsapi Client
     */
    public static function createClient(){

        $config = new Config([
            // 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID。
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            // 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
            "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();
        // 建立請求對象並設定入參
        $sendSmsRequest = new SendSmsRequest([
            "signName" => "<YOUR_VALUE>",
            "templateCode" => "<YOUR_VALUE>",
            "phoneNumbers" => "<YOUR_VALUE>",
        ]);
        try {
            // 複製代碼運行請自行列印 API 的傳回值
            $client->sendSms($sendSmsRequest);
        }
        catch (Exception $error) {
            if (!($error instanceof TeaError)) {
                $error = new TeaError([], $error->getMessage(), $error->getCode(), $error);
            }
            // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
            // 錯誤 message
            var_dump($error->message);
            // 診斷地址
            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));

<介面名稱>WithOptions：可配置自訂運行時參數發起介面調用，更多運行時參數配置請參見進階配置。

<?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 {

    /**
     * 使用AK&SK初始化帳號Client
     * @return Dysmsapi Client
     */
    public static function createClient(){

        $config = new Config([
            // 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID。
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            // 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
            "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();
        // 建立請求對象並設定入參
        $sendSmsRequest = new SendSmsRequest([
            "signName" => "<YOUR_VALUE>",
            "templateCode" => "<YOUR_VALUE>",
            "phoneNumbers" => "<YOUR_VALUE>",
        ]);
        // 建立運行時設定物件
        $runtime = new RuntimeOptions([]);
        try {
            // 複製代碼運行請自行列印 API 的傳回值
            $client->sendSmsWithOptions($sendSmsRequest, $runtime);
        }
        catch (Exception $error) {
            if (!($error instanceof TeaError)) {
                $error = new TeaError([], $error->getMessage(), $error->getCode(), $error);
            }
            // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
            // 錯誤 message
            var_dump($error->message);
            // 診斷地址
            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));

<介面名稱>Advance：專門用於應對直接上傳Object 的情境，該方法預設需要傳入運行時參數。下述樣本以視覺智能開放平台人體人臉產品為例介紹SDK如何使用本地檔案上傳調用 API。

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 {

    /**
     * 使用AK&SK初始化帳號Client
     * @return Facebody Client
     */
    public static function createClient(){

        $config = new Config([
            // 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID。
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            // 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
            "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();
        // 建立請求對象並設定入參
        $detectBodyCountRequest = new DetectBodyCountRequest([
            "imageURL" => "<YOUR_VALUE>"
        ]);
        // 建立運行時設定物件
        $runtime = new RuntimeOptions([]);
        try {
            // 複製代碼運行請自行列印 API 的傳回值
            $client->detectBodyCountWithOptions($detectBodyCountRequest, $runtime);
        }
        catch (Exception $error) {
            if (!($error instanceof TeaError)) {
                $error = new TeaError([], $error->getMessage(), $error->getCode(), $error);
            }
            // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
            // 錯誤 message
            var_dump($error->message);
            // 診斷地址
            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));