本文将详细介绍智能推荐的PHP SDK安装步骤及调用示例。主要内容包括如何调用智能推荐以创建智能推荐实例接口,通过指定的实例ID查看实例详情接口,以及启动实例开始全量数据导入任务接口,并提供完整的集成步骤。
前提条件
调用阿里云OpenAPI通常需要设置访问密钥(AccessKey)。请确保已创建AccessKey。具体操作,请参见创建AccessKey。为了避免凭据泄露,常见的方案是将其写入到环境变量中,更多安全方案请参见使用访问凭据访问阿里云OpenAPI最佳实践。
环境要求
最低要求 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/
步骤一:引入SDK
阿里云SDK支持泛化与特化两种方式调用OpenAPI,详情参见泛化调用与特化调用,不同的调用方式需要引入的SDK也不同。
特化调用
您可以访问OpenAPI门户网站,搜索您需要的产品,查看产品支持的SDK语言及安装方法,然后在您的项目中引入SDK。本案例的SDK获取步骤如下:
访问智能推荐。
在所有语言栏目中选择您需要的SDK语言。
选择您需要的安装方式,将代码复制到您的项目中。
在您的项目中载入该依赖包。
其PHP语言安装产品如下:
composer require alibabacloud/airec-20201126 1.0.0
泛化调用
泛化调用方式不依赖任何一个产品的SDK,只依赖如下核心包com.aliyun.tea-openapi
。其PHP语言安装配置文件如下,最新版本请参见tea-openapi。
composer require alibabacloud/darabonba-openapi
步骤二:初始化Client
请根据智能推荐所属地域正确填写服务接入地址(又称“访问端点”或“Endpoint”),关于服务接入地址的更多信息,请参见支持的地域。
以下将以特化调用代码为例,详细说明调用过程。如您选择泛化调用方案,更多信息请参见泛化调用与特化调用。
使用AK初始化
阿里云账号AccessKey拥有所有OpenAPI的访问权限,建议您使用RAM用户进行API访问或日常运维。强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。
本示例以将AccessKey配置在环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET的方式来实现身份验证为例。
更多认证信息配置方式,请参见管理访问凭据。
不同操作系统的环境变量配置方法不同,具体操作,请参见在Linux、macOS和Windows系统配置环境变量。
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Airec\V20201126\Airec;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* 使用AK&SK初始化账号Client
* @return Airec 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")
]);
// Endpoint 请参考 https://api.aliyun.com/product/Airec
$config->endpoint = "airec.cn-hangzhou.aliyuncs.com";
return new Airec($config);
}
}
步骤三:使用已初始化的Client调用智能推荐API
初始化Client后,您可以通过Client调用智能推荐API。
接口名称:CreateInstance
此接口用于创建一个智能推荐预付费实例。调用该API无需参数,您需要根据实际业务需求设置运行时配置。同时,您也可以自定义运行时配置以满足特定需求。
// 运行时配置
$runtime = new RuntimeOptions([]);
以下是使用AK创建一个智能推荐预付费实例的完整示例代码:
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Airec\V20201126\Airec;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* 使用AK&SK初始化账号Client
* @return Airec 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")
]);
// Endpoint 请参考 https://api.aliyun.com/product/Airec
$config->endpoint = "airec.cn-hangzhou.aliyuncs.com";
return new Airec($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
$client = self::createClient();
$runtime = new RuntimeOptions([]);
$headers = [];
try {
// 复制代码运行请自行打印 API 的返回值
$client->createInstanceWithOptions($headers, $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));
接口名称:DescribeInstance
此接口用于通过指定的实例ID查看实例详情。您需要根据实际业务需求设置相应的参数及运行时配置。同时,您也可以自定义运行时配置以满足特定需求。
// 运行时配置
$runtime = new RuntimeOptions([]);
$headers = [];
// 设置请求参数
$client->describeInstanceWithOptions("airec-cn-****", $headers, $runtime);
以下是使用AK通过指定的实例ID获取实例详情的完整示例代码:
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Airec\V20201126\Airec;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* 使用AK&SK初始化账号Client
* @return Airec 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")
]);
// Endpoint 请参考 https://api.aliyun.com/product/Airec
$config->endpoint = "airec.cn-hangzhou.aliyuncs.com";
return new Airec($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
$client = self::createClient();
$runtime = new RuntimeOptions([]);
$headers = [];
try {
// 复制代码运行请自行打印 API 的返回值
$client->describeInstanceWithOptions("airec-cn-****", $headers, $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));
接口名称:RunInstance
此接口用于启动一个实例开始全量数据导入任务。您需要根据实际业务需求设置相应的参数及运行时配置。同时,您也可以自定义运行时配置以满足特定需求。
// 运行时配置
$runtime = new RuntimeOptions([]);
$headers = [];
// 设置请求参数
$client->runInstanceWithOptions("airec-cn-****", $headers, $runtime);
以下是使用AK通过指定的实例ID启动实例开始全量数据导入任务的完整示例代码:
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Airec\V20201126\Airec;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* 使用AK&SK初始化账号Client
* @return Airec 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")
]);
// Endpoint 请参考 https://api.aliyun.com/product/Airec
$config->endpoint = "airec.cn-hangzhou.aliyuncs.com";
return new Airec($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
$client = self::createClient();
$runtime = new RuntimeOptions([]);
$headers = [];
try {
// 复制代码运行请自行打印 API 的返回值
$client->runInstanceWithOptions("airec-cn-****", $headers, $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));