You need to enable JavaScript to run this app.
视频点播

视频点播

复制全文
PHP SDK
集成 PHP SDK
复制全文
集成 PHP SDK

本文档旨在指导 PHP 开发者如何快速地将视频点播服务端 SDK 集成到您的项目中,并完成客户端的初始化。

环境要求

  • PHP 7.1 或更高版本。
  • Composer 依赖管理工具。

集成步骤

步骤 1:安装 SDK

视频点播 PHP SDK 通过 Composer 进行管理。请在您的项目根目录下,执行以下命令来安装 SDK。

composer require volcengine/volc-sdk-php

说明

  • 强烈建议您前往 GitHub 版本发布历史页面,获取并使用最新版本号,以确保您能使用全部最新的 API 和功能。请安装 v1.0.87 或之后版本。
  • 如果发现接口或功能在当前版本不存在,请尝试执行 composer update volcengine/volc-sdk-php 将 SDK 升级到最新版本。
  • 如果访问 packagist 超时,可使用国内镜像配置环境。

安装完成后,请确保在您的 PHP 文件中引入 Composer 的 autoload.php 文件。

require 'vendor/autoload.php';

步骤 2:配置访问凭证(AK/SK)

为了让 SDK 能够验证您的身份并发起 API 调用,您需要配置访问密钥(Access Key)。

说明

在火山引擎控制台的密钥管理页面创建并获取 AK 和 SK。

方式 1:通过环境变量配置(推荐)

此方式将敏感信息与代码解耦,提升了安全性。您只需在运行程序的服务器环境中设置以下两个环境变量即可,SDK 会自动读取。

export VOLC_ACCESSKEY="Your_AK"
export VOLC_SECRETKEY="Your_SK"

方式 2:通过配置文件配置

您可以在用户主目录(~)下创建一个 .volc/config 文件,并按以下 JSON 格式填入您的 AK 和 SK。SDK 会自动从此路径加载凭证。

{
   "ak":"Your_AK",
   "sk":"Your_SK"
}

方式 3:在代码中显式设置

在某些临时测试或特殊场景下,您也可以在代码中直接设置 AK 和 SK。

警告

安全警告:此方式存在敏感信息硬编码在代码中的风险。请不要在生产环境的代码中直接包含 AK 和 SK,以防源码泄露导致密钥丢失。

use Volc\Service\Vod\Vod;

$client = Vod::getInstance();
$client->setAccessKey('Your_AK');
$client->setSecretKey('Your_SK');

步骤 3:创建客户端实例

完成 SDK 安装和凭证配置后,您就可以初始化视频点播服务的客户端实例 Vod 了。

场景 1:创建默认地域的实例

最简单的方式是创建一个使用默认地域(华北1 cn-north-1)的实例。

说明

  • 亚太东南(柔佛)地域仅针对企业用户开放。功能支持情况详见服务地域
  • 如果您需要同时访问多个不同地域的服务,为每个地域创建一个独立的实例。
use Volc\Service\Vod\Vod;

// 如果您已通过环境变量或配置文件设置 AK/SK,则无需再调用 setAccessKey/setSecretKey
$client = Vod::getInstance();

场景 2:创建指定地域的实例

如果您的业务需要访问特定地域(Region)的服务,可以在初始化时传入地域参数。

说明

  • 亚太东南(柔佛)地域仅针对企业用户开放。功能支持情况详见服务地域
  • 如果您需要同时访问多个不同地域的服务,为每个地域创建一个独立的 Vod 实例。
use Volc\Service\Vod\Vod;

// 创建一个华北1 (cn-north-1) 地域的实例
$clientNorth1 = Vod::getInstance('cn-north-1');

// 创建一个亚太东南1 (ap-southeast-1) 地域的实例
// 亚太东南(柔佛)请使用 v1.0.101 或之后版本
$clientApSouthEast1 = Vod::getInstance('ap-southeast-1');

步骤 4:发起 API 调用

获取到 client 实例后,您就可以调用其下的具体方法来发起 API 请求了。不同功能模块的接口调用示例,请参见以下文档:

最近更新时间:2025.12.19 11:02:41
这个页面对您有帮助吗?
有用
有用
无用
无用