README

这是一个 PHP 对 Wistia 数据 API 的包装器。对象和方法的完整列表在下面。

基本用法

//Your wistia api key
$apikey = "abcdefg123456";

//A wistia media id
$media_id = "xyz123";

//Get a Medias Resource
$media = \Wistia\Wistia::getResource("Medias", $apikey);

//Call the Api Method on the resource
$results = $media->show($media_id);

//Now test if api call was successful
if($results->isSuccess()){
	
	//It was successful
	//now get results
	//and do something
	echo $results->getResults();

}else{

	//Not successful
	//So do something
	echo $results->getStatus();

}

场景 1：如果您想显示 ID 为 `xyz123` 的特定项目

//Your wistia api key
$apikey = "abcdefg123456";

$project_id = "xyz123";

//Get Projects Resource
$projects = \Wistia\Wistia::getResource("Projects", $apikey);

//Then call the method on the project
$results = $projects->show($project_id);

场景 2：如果您想删除语言为 `eng` 的视频 `xyz123` 的字幕

//Your wistia api key
$apikey = "abcdefg123456";

$media_id = "xyz123";

//Get Captions Object
$captions = \Wistia\Wistia::getResource("Captions", $apikey);

//Then call the method on captions
$results = $captions->delete($media_id, array(
											"language" => "eng"
										));

您从方法接收到的 `$results` 是一个具有三个方法的简单对象。

$results = $projects->show("project id");

//Get Status Code from Response Header
$results->getStatus();    //200 or 201 or 404 ...

//Get Response JSON string 
$results->getResults();   //{"wistia":"json"}

//Test if result is Successful
//returns true if status === 200 or 201
//and false for everything else
$results->isSuccess();

如果您出于某种奇怪的原因想直接实例化类，您也可以这样做！

//Your wistia api key
$apikey = "abcdefg123456";

$media_id = "xyz123";

//Get Captions Object
$captions = new \Wistia\Resources\Captions($apikey);

//Then call the method on captions
$results = $captions->delete($media_id, array(
											"language"
										));

对象的完整列表、方法和它们的参数直接映射到 Wistia 数据 API（大部分如此）。任何 Wistia 使用 `list` 的地方，我们都要使用 `listOf`，因为 `list` 是 PHP 中的一个受保护词。下面列表的分解是 `Object -> Method -> Parameter`。`[$param] = 可选参数`

项目
- listOf
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- show
  - $project_id - Wistia API 签名的项目 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- create
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- update
  - $project_id - Wistia API 签名的项目 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- delete
  - $project_id - Wistia API 签名的项目 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- copy
  - $project_id - Wistia API 签名的项目 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
共享
- listOf
  - $project_id - Wistia API 签名的项目 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- show
  - $project_id - Wistia API 签名的项目 ID
  - $sharing_id - Wistia API 签名的共享 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- create
  - $project_id - Wistia API 签名的项目 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- update
  - $project_id - Wistia API 签名的项目 ID
  - $sharing_id - Wistia API 签名的共享 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- delete
  - $project_id - Wistia API 签名的项目 ID
  - $sharing_id - Wistia API 签名的共享 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
媒体
- listOf
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- show
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- update
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- delete
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- copy
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- stats
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
账户
- get
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
定制
- show
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- create
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- update
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- delete
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
字幕
- index
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- create
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- show
  - $media_id - Wistia API 签名的媒体 ID
  - $language_code - ISO-639-2 语言代码 - 三个字母代码
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- update
  - $media_id - Wistia API 签名的媒体 ID
  - $language_code - ISO-639-2 语言代码 - 三个字母代码
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- delete
  - $media_id - Wistia API 签名的媒体 ID
  - $language_code - ISO-639-2 语言代码 - 三个字母代码
  - [$params] - Wistia API 参数，请参阅 Wistia 文档
- purchase
  - $media_id - Wistia API 签名的媒体 ID
  - [$params] - Wistia API 参数，请参阅 Wistia 文档

jafrisella / wistia_api

维护者

详情

README