README

PHP-API-Connector (适用于 PHP 7+)

1.0 欢迎使用

✅ GET /api/v2/ 您可以使用此功能测试身份验证

1.1 ApiKey

✅ DELETE /api/v2/apikey 您可以使用此功能通过用户名/密码删除特定用户的身份验证密钥（APIKEY）

✅ GET /api/v2/apikey 您可以使用此功能通过用户名/密码获取特定用户的身份验证密钥（APIKEY）

2.0 项目

✅ GET /api/v2/projects 返回可用的项目集合

✅ POST /api/v2/projects 创建新项目

✅ DELETE /api/v2/projects/{ProjectId} 通过 ID 删除项目

✅ GET /api/v2/projects/{ProjectId} 返回项目

✅ PUT /api/v2/projects/{ProjectId} 修改项目的属性

2.2 项目文件编码器

GET /api/v2/projects/{ProjectId}/fileencodersettings 返回视频点播项目中文件编码的全局设置

PUT /api/v2/projects/{ProjectId}/fileencodersettings 设置视频点播项目中文件编码的全局设置

PUT /api/v2/projects/{ProjectId}/fileencodersettings/watermarkpicture 添加水印图片

LINK /api/v2/projects/{ProjectId}/fileencodersettings/fileformat/{FileFormatId} 将（链接）文件格式添加到文件编码设置

UNLINK /api/v2/projects/{ProjectId}/fileencodersettings/fileformat/{FileFormatId} 从文件编码设置中移除（取消链接）文件格式

✅ GET /api/v2/projects/{ProjectId}/fileformatsettings 返回视频点播项目的所有全局文件格式设置

✅ GET /api/v2/projects/{ProjectId}/fileformatsettings/{FileFormatId} 返回视频点播项目的文件格式设置

✅ PUT /api/v2/projects/{ProjectId}/fileformatsettings/{FileFormatId} 设置视频点播项目的文件格式设置

2.3 项目文件编码器流水线

GET /api/v2/projects/{ProjectId}/pipeline 返回视频点播项目中编码流水线中的资产

GET /api/v2/projects/{ProjectId}/pipeline/{FileId} 返回视频点播项目中文件（由 FileId 指定）的流水线资产

PUT /api/v2/projects/{ProjectId}/pipeline/{FileId} 设置视频点播项目中文件（由 FileId 指定）的编码流水线资产设置

LINK /api/v2/projects/{ProjectId}/pipeline/{FileId}/fileformat/{FileFormatId} 将（链接）文件格式添加到流水线资产

UNLINK /api/v2/projects/{ProjectId}/pipeline/{FileId}/fileformat/{FileFormatId} 从流水线资产中移除（取消链接）文件格式

PUT /api/v2/projects/{ProjectId}/pipeline/{FileId}/watermarkpicture 将水印图片添加到流水线资产

2.4 项目使用

GET /api/v2/projects/{ProjectId}/usage 返回项目使用的资源。参数：'Start' [YYYY-MM-DD] 报告期开始，'End' [YYYY-MM-DD] 报告期结束，'Resolution' ['month'|'day'] 数据的详细信息。

3.0 通道

✅ GET /api/v2/channels 返回可用的通道集合

✅ GET /api/v2/channels/{ChannelId} 返回通道

3.1 通道图片

✅ GET /api/v2/channels/{ChannelId}/picture 返回通道图片

✅ PUT /api/v2/channels/{ChannelId}/picture 添加通道图片

3.2 通道元数据

✅ GET /api/v2/channels/{ChannelId}/metadata 返回通道的元数据

✅ PUT /api/v2/channels/{ChannelId}/metadata 更改通道元数据

✅ PUT /api/v2/channels/{ChannelId}/metadata/boardpicture 添加通道元数据板图片

✅ PUT /api/v2/channels/{ChannelId}/metadata/creditspicture 添加通道元数据信用图片

3.3 通道输入

✅ GET /api/v2/channels/{ChannelId}/input 返回通道输入

✅ PUT /api/v2/channels/{ChannelId}/input 更改通道输入

3.4 通道输出

✅ GET /api/v2/channels/{ChannelId}/output 返回通道的输出 URI

3.5 通道嵌入

✅ GET /api/v2/channels/{ChannelId}/embed 返回通道的嵌入代码

✅ GET /api/v2/channels/{ChannelId}/embedstate 返回通道嵌入代码的播放状态

✅ PUT /api/v2/channels/{ChannelId}/embedstate 更改通道嵌入代码的播放状态

3.6 通道转码器

✅ GET /api/v2/channels/{ChannelId}/formats 返回可用的通道转码器格式

✅ 链接 /api/v2/channels/{ChannelId}/formats/{ChannelFormatId} 将 ChannelFormat 添加到 Channel 并创建新的 Transcoder

✅ 断开链接 /api/v2/channels/{ChannelId}/formats/{ChannelFormatId} 从 Channel 移除 ChannelFormat 并删除 Transcoder

✅ GET /api/v2/channels/{ChannelId}/transcoders 返回启用的 Channel Transcoders

3.7 通道分发

✅ GET /api/v2/channels/distributions 返回启用的 Channel 分发

✅ POST /api/v2/channels/{ChannelId}/distributions 创建新的 Channel 分发

✅ DELETE /api/v2/channels/{ChannelId}/distributions/{ChannelDistributionId} 通过 Id 删除 Channel 分发

✅ GET /api/v2/channels/{ChannelId}/distributions/{ChannelDistributionId} 通过 Id 返回 Channel 分发

✅ PUT /api/v2/channels/{ChannelId}/distributions/{ChannelDistributionId} 编辑 Channel 分发

✅ PUT /api/v2/channels/{ChannelId}/distributions/{ChannelDistributionId}/StartStop 启动或停止 Channel 分发

3.7 通道时移清除

✅ GET /api/v2/channels/{ChannelId}/timeshift/purge 创建清除时移作业

4.0 文件

✅ GET /api/v2/projects/{ProjectId}/files 返回项目中的文件集合

✅ POST /api/v2/projects/{ProjectId}/files 创建新的文件实体并返回 Location 标头中的文件上传 URI

✅ DELETE /api/v2/projects/{ProjectId}/files/{FileId} 通过 Id 删除文件

✅ GET /api/v2/projects/{ProjectId}/files/{FileId} 通过 Id 返回文件

4.1 文件元数据

✅ GET /api/v2/projects/{ProjectId}/files/{FileId}/metadata 返回文件的元数据

✅ PUT /api/v2/projects/{ProjectId}/files/{FileId}/metadata 更改文件的元数据

4.2 文件元数据类别

链接 /api/v2/projects/{ProjectId}/files/{FileId}/metadata/category/{CategoryId} 将类别添加到文件元数据

断开链接 /api/v2/projects/{ProjectId}/files/{FileId}/metadata/category/{CategoryId} 从文件元数据中移除类别

4.3 文件元数据视频类型

链接 /api/v2/projects/{ProjectId}/files/{FileId}/metadata/videotype/{VideotypeId} 将视频类型添加到文件元数据

断开链接 /api/v2/projects/{ProjectId}/files/{FileId}/metadata/videotype/{VideotypeId} 从文件元数据中移除视频类型

4.4 文件播放

✅ GET /api/v2/projects/{ProjectId}/files/{FileId}/playouts 返回文件的播放 Id

✅ GET /api/v2/projects/{ProjectId}/files/{FileId}/playouts/default/embed 返回文件默认播放的嵌入代码

✅ GET /api/v2/projects/{ProjectId}/files/{FileId}/playouts/{PlayoutId}/embed 返回文件播放的嵌入代码

4.5 文件输出

✅ GET /api/v2/projects/{ProjectId}/files/{FileId}/output 返回文件的输出 URI

4.6 文件图片

✅ GET /api/v2/projects/{ProjectId}/files/{FileId}/pictures 返回文件的图片

✅ POST /api/v2/projects/{ProjectId}/files/{FileId}/pictures 创建新的文件图片并将其设为标准图片

✅ GET /api/v2/projects/{ProjectId}/files/{FileId}/pictures/standard 返回文件的标准（默认）图片

✅ DELETE /api/v2/projects/{ProjectId}/files/{FileId}/pictures/{FilePictureId} 删除此文件图片

✅ PUT /api/v2/projects/{ProjectId}/files/{FileId}/pictures/{FilePictureId}/standard 将此设为标准（默认）文件图片

5.0 类别

GET /api/v2/categories 返回可用的类别集合

GET /api/v2/categories/{CategoryId} 返回类别

PUT /api/v2/categories/{CategoryId} 更改类别的属性

PUT /api/v2/categories/{CategoryId}/picture 设置类别图片

7.0 报告 - 项目

GET /api/v2/reporting/projects/{ProjectId}/views 返回项目的报告

7.1 报告 - 文件

GET /api/v2/reporting/projects/{ProjectId}/fileviews 返回视频项目的 FileView 报告

GET /api/v2/reporting/projects/{ProjectId}/fileviews/{FileId} 返回视频项目中文件的 FileView 报告

7.2 报告 - 用户

GET /api/v2/reporting/projects/{ProjectId}/fileuserviews 返回视频项目中用户的 FileView 报告

GET /api/v2/reporting/projects/{ProjectId}/fileuserviews/{UserToken} 返回由 UserToken 识别的用户视频项目的 FileView 报告

7.3 报告 - 国家，设备

GET /api/v2/reporting/projects/{ProjectId}/countries 返回关于项目观看的国家报告

GET /api/v2/reporting/projects/{ProjectId}/devices 返回关于项目观看的设备报告