You need to enable JavaScript to run this app.
导航
安装及初始化
最近更新时间:2024.05.30 19:25:50首次发布时间:2021.02.23 10:42:26

veImageX 支持使用 SDK 完成 API 的调用,您可参考以下内容快速完成服务端 PHP SDK 的安装及初始化操作。

前提条件

  • 已开通 veImageX 服务
  • 已安装 PHP 7.1 及以上版本,可通过 php -v 命令查看当前版本。
  • 已安装 Composer,用以管理和安装项目的依赖项。
  • 已获取访问 veImageX 所需的 AK/SK。由于主账号 AK/SK 一旦泄漏,将有严重的安全风险,推荐您使用临时访问凭证来访问产品服务。

注意事项

为避免 AK/SK 泄漏,引起安全风险。建议您定期更换 AK 和 SK使用访问策略限制权限采用安全存储等方式提高安全性。

安装 SDK

执行以下 Composer 命令获取最新版服务端 SDK。如果您已经安装过历史版本的 SDK,可以执行更新 SDK 命令更新到最新版本。

composer require volcengine/volc-sdk-php

初始化

配置访问 AK/SK

veImageX 支持两种 AK 和 SK 的配置方式,在验证和测试阶段,您可以使用在调试 Demo 中配置的方式。如果需要发布到生产环境,请使用在环境变量中配置的方式。

注意

在调用中,系统会自动读取配置参数,您在调试代码中配置的 AK 和 SK 优先级高于环境变量配置。

  • 在 Linux 或 macOS 系统中配置

    请在命令行终端执行以下命令,并传入已准备好的 AK 和 SK。

export VOLC_ACCESSKEY="ak"
export VOLC_SECRETKEY="sk"
  	
  • 在 Windows 系统中配置

    新建系统环境变量,添加环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,并传入已准备好的 AK 和 SK。

配置访问 Region

veImageX 支持以下两个地域:

  • cn-north-1:(默认)国内
  • ap-singapore-1:新加坡

默认地域为中国(cn-north-1),若需调用其它地域服务,请在初始化时传入指定的地域信息。

$client = Imagex::getInstance(); // 默认地域为中国
$client = Imagex::getInstance($region = 'ap-singapore-1'); // 指定地域为新加坡

后续步骤

至此,您已成功完成 PHP SDK 的安装和初始化。接下来,您可以参考各接口的调试示例来使用相应的能力。

相关操作

更新 SDK

执行以下命令将 SDK 更新至最新版本。

composer update