本文档旨在指导您快速地将视频点播服务端 SDK 集成到您的项目中,并完成初始化。
视频点播 Python SDK 通过 pip 进行管理。打开您的终端,执行以下命令即可安装。
pip install --user volcengine
说明
pip install --upgrade volcengine,将 SDK 升级到最新版本。sudo(不推荐)。为了让 SDK 能够验证您的身份并发起 API 调用,您需要配置访问密钥(Access Key)。
说明
在火山引擎控制台的密钥管理页面创建并获取 AK 和 SK。
此方式将敏感信息与代码解耦,提升了安全性。您只需在运行程序的服务器环境中设置以下两个环境变量即可,SDK 会自动读取。
export VOLC_ACCESSKEY="Your_AK" export VOLC_SECRETKEY="Your_SK"
您可以在用户主目录(~)下创建一个 .volc/config 文件,并按以下 JSON 格式填入您的 AK 和 SK。SDK 会自动从此路径加载凭证。
{ "ak":"Your_AK", "sk":"Your_SK" }
在某些临时测试或特殊场景下,您也可以在代码中直接设置 AK 和 SK。
警告
安全警告:此方式存在敏感信息硬编码在代码中的风险。请不要在生产环境的代码中直接包含 AK 和 SK,以防源码泄露导致密钥丢失。
from volcengine.vod.VodService import VodService vod_service = VodService() vod_service.set_ak('Your_AK') vod_service.set_sk('Your_SK')
完成 SDK 安装和凭证配置后,您就可以初始化视频点播服务的客户端实例 VodService 了。
最简单的方式是创建一个使用默认地域(华北1 cn-north-1)的实例。
from volcengine.vod.VodService import VodService # 如果您已通过环境变量或配置文件设置 AK/SK,则无需再调用 set_ak/set_sk vod_service = VodService()
如果您的业务需要访问特定地域(Region)的服务,可以在初始化时传入地域参数。
说明
VodService 实例。# 创建一个华北1 (cn-north-1) 地域的实例 vod_service1 = VodService('cn-north-1') # 创建一个亚太东南1 (ap-southeast-1) 地域的实例 # 亚太东南(柔佛)请使用 v1.0.126 或之后版本 vod_service2 = VodService('ap-southeast-1')
获取到 vod_service 实例后,您就可以调用 call 方法来发起 API 请求了。不同功能模块的接口调用示例,请参见以下文档: