README

运行以下命令安装包

composer require clickonmedia/frameio-php-client

Frame.io API 文档

https://docs.frame.io/reference

基本用法

require __DIR__ . '/vendor/autoload.php';
use Frameio\FrameIOClient;

$frameIO =  new FrameIOClient(<frameio-token>);
echo $frameIO->getHost();

开发 / 运行测试

从根目录复制 .env.example 文件并将其重命名为 .env。根据 Frame.io 控制台信息填写文件中的变量。

composer install
composer run-script test

可用功能

获取用户资料

$frameIO->getProfile()

获取用户的团队

$frameIO->getTeams()

通过账户 ID 获取团队

@param string $accountId 账户 ID（必需）

$frameIO->getTeamsByAccountId( $accountId )

获取团队中的用户成员资格

@param string $teamId 团队 ID（必需）

$frameIO->getTeamMembership( $teamId )

将用户成员资格添加到团队

@param string $teamId 团队 ID（必需）
@param string $userId 用户 ID（必需）
@param string $role 成员角色（必需）

$frameIO->addTeamMembership( $teamId, $userId, $role )

创建项目

@param string $name 项目名称（必需）
@param string $teamId 团队 ID（必需）
@param boolean $private 将项目设置为私有（可选）

$frameIO->createProject( $name, $teamId, $private )

通过 ID 获取项目

@param string $projectId 项目 ID（必需）

$frameIO->getProjectById( $projectId )

通过 ID 删除项目

@param string $projectId 项目 ID（必需）

$frameIO->deleteProjectById( $projectId )

通过团队 ID 获取项目

@param string $teamId 团队 ID（必需）

$frameIO->getProjectsByTeamid( $teamId )

获取项目中的用户成员资格

@param string $projectId 项目 ID（必需）

$frameIO->getUserMembershipForProject( $projectId )

将协作者添加到团队

@param string $projectId 项目 ID（必需）
@param string $email 用户电子邮件地址（必需）

$frameIO->addCollaboratorToTeam( $projectId, $email )

创建资产

https://docs.frame.io/reference#createasset

@param string $projectId 项目 ID（必需）

@param string $args 其他参数（必需）

name string 名称（必需）
filesize int 文件大小（必需）
type string 类型（必需: "file" 或 "folder"）
description string 描述（可选）
filetype string 文件类型（可选，例如 "video/mp4"）
fileUrl string 文件 URL（可选）
properties array 自定义属性（可选）

$frameIO->createAsset( $projectId, $args );

获取资产

@param string $rootAssetId 父资产 ID（必需）
@param string $type 类型（默认值: "file"）

$frameIO->getAssets( $rootAssetId, $type )

通过 ID 获取资产

@param string $assetId 资产 ID（必需）

$frameIO->getAssetById( $assetId )

更新资产

@param string $assetId 资产 ID（必需）
@param string $name 名称（必需）
@param string $args 其他参数（可选）

$frameIO->updateAssetById( $assetId, $name, $args )

通过 ID 删除资产

@param string $assetId 资产 ID（必需）

$frameIO->deleteAssetById( $assetId )

向资产添加版本

@param string $assetId 资产 ID（必需）
@param string $nextAssetId 下一个资产 ID（必需）

$frameIO->addVersionToAsset( $assetId, $nextAssetId )

获取项目资产

@param string $projectId 项目 ID（必需）

$frameIO->getProjectAssets( $projectId )

将文件上传到资产

@param object $asset 资产对象（必需）
@param string $file_path 文件路径（必需）

$frameIO->upload( $asset, $file_path );

创建评论

@param string $assetId 资产 ID（必需）
@param object $args 其他参数（必需）

text string 评论内容（可选）
annotation string 几何形状和/或绘图数据的序列化列表（可选）
timestamp string 评论时间戳，以帧为单位（可选）
page string 评论的页码（可选，仅限文档）
pitch integer 评论的俯仰测量值（可选，仅限 360 度视频）
yaw string 评论的偏航测量值（可选，仅限 360 度视频）

$frameIO->createComment( $assetId, $args )

通过资产 ID 获取评论

@param string $assetId 资产 ID（必需）

$frameIO->getComments( $assetId )

通过评论 ID 获取评论

@param string $commentId 评论 ID（必需）

$frameIO->getCommentById( $commentId )

更新评论

@param string $commentId 评论 ID（必需）
@param string $text 评论文本（默认值: "")

$frameIO->updateComment( $commentId, $text )

删除评论

@param string $commentId 评论 ID（必需）

$frameIO->deleteCommentById ( $commentId )

获取项目的审阅链接

@param string $projectId 项目 ID（必需）

$frameIO->getReviewLinks( $projectId )

创建审阅链接

@param string $projectId 项目 ID（必需）
@param string $name 审阅链接名称（必填）
@param string $args 其他参数（可选）

allow_approvals boolean 允许审批（默认值：false）
current_version_only boolean 仅当前版本（默认值：false）
enable_downloading boolean 启用下载（默认值：false）
requires_passphrase boolean 需要密码短语（默认值：false）
password string 密码（默认值：""）
expires_at string 过期时间（默认值：""）

$frameIO->createReviewLink( $projectId, $name, $args )

更新审阅链接

@param string $reviewLinkId 审阅链接ID（必填）
@param string $name 审阅名称（必填）
@param string $args 其他参数（可选）

allow_approvals boolean 允许审批（默认值：false）
current_version_only boolean 仅当前版本（默认值：false）
enable_downloading boolean 启用下载（默认值：false）
requires_passphrase boolean 需要密码短语（默认值：false）
password string 密码（默认值：""）
expires_at string 过期时间（默认值：""）

$frameIO->UpdateReviewLink( $reviewLinkId, $name, args )

获取审阅链接

@param string $link_id 审阅链接ID（必填）

$frameIO->getReviewLink( $link_id )

获取审阅链接项目

@param string $link_id 审阅链接ID（必填）

$frameIO->getReviewLinkItems( $link_id )

将资产添加到审阅链接

https://docs.frame.io/reference#reviewlinkitemcreate

@param string $reviewLinkId 审阅链接ID（必填）
@param array $assetIds 资产ID（必填，ID数组）

$frameIO->addAssetsToReviewLink( $reviewLinkId, $assetIds )

搜索资产

@param string $query 搜索查询（默认值：""）
@param string $teamId 团队ID（默认值：""）
@param string $accountId 账户ID（默认值：""）

$frameIO->getSearchAssets ( $query, $teamId, $accountId )

搜索资产（复杂）

@param string $query 搜索查询（默认值：""）
@param string $teamId 团队ID（默认值：""）
@param string $accountId 账户ID（默认值：""）
@param string $filter 查询过滤器（默认值：[], 键值对数组）

$frameIO->searchAssets ( $query , $teamId , $accountId, $filter )