README

如果您想为该项目做出贡献，请fork存储库并提交一个包含您工作的pull request。文档将在添加端点时更新。

安装

我们建议使用composer来管理依赖项和安装Image Relay API PHP库。如果您不熟悉composer，可以在此处了解如何在您的应用程序中安装 - Composer安装教程

从您的控制台运行以下命令

	$ php composer.phar require imagerelay/imagerelay-php

用法

要使用库，您只需要拥有一个具有适当权限的Image Relay账户来完成API操作。您需要require composer提供的vender/autoload.php文件。

使用用户名和密码进行授权

不要忘记将imagerelay_url更改为使用您自己的子域或自定义url。

<?php
	require_once 'vendor/autoload.php';

	$client = ImageRelay\ImageRelayClient::factory(array(
	    'imagerelay_url' => 'subdomain.imagerelay.com',
	    'auth' => 'http',
	    'username' => 'username',
	    'password' => 'password',
	    'app_name' => 'Sample APP',
	    'app_contact' => 'http://www.sampleapp.com',
	));
?>

使用OAuth进行授权

当使用OAuth进行授权时，您需要使用许多现有的库之一来检索您的OAuth访问令牌。Image Relay API遵循OAuth标准进行认证。

不要忘记将imagerelay_url更改为使用您自己的子域或自定义url。

<?php
	require_once 'vendor/autoload.php';

	$client = ImageRelay\ImageRelayClient::factory(array(
	    'imagerelay_url' => 'subdomain.imagerelay.com',
	    'auth' => 'oauth',
	    'token' => '08dfsafd8asdf8asdf90as8df90df8',
	    'app_name' => 'Sample APP',
	    'app_contact' => 'http://www.sampleapp.com',
	));
?>

文件

Image Relay API：文件

从文件夹获取文件

	$response = $client->getFiles( array(
		'folder_id' => 8363117,
		'page' => 2,
	));

获取文件

	$response = $client->getFile( array(
		'id' => 8363117,
	));

从URL上传文件

	$response = $client->uploadFileFromURL( array(
		'filename' => 'test.jpg',
		'folder_id' => 285356,
		'file_type_id' => 1464,
		'terms' => array(
			'term_id' => '145',
			'value' => 'Test Value',
		),
		'url' => 'https://upload.wikimedia.org/wikipedia/commons/5/55/Atelopus_zeteki1.jpg'
	));

文件夹

Image Relay API：文件夹

获取文件夹

顶级文件夹

$response = $client->getFolders('page' => 1);

父文件夹的子文件夹

$response = $client->getChildFolders( array(
	'folder_id' => 191678,
	'page' => 1
));

根文件夹

$response = $client->getRootFolder();

获取文件夹

$response = $client->getFolder( array(
	'folder_id' => 191678,
));

创建文件夹

$response = $client->createFolder( array(
	'folder_id' => 191678,
	'name' => 'Testing Folder Create',
));

更新文件夹

$response = $client->updateFolder( array(
	'folder_id' => 290503,
	'name' => 'New Folder Create',
));

文件类型

Image Relay API：文件类型

获取文件类型

$response = $client->getFileTypes();

获取文件类型

$response = $client->getFileType( array(
	'id' => 290503,
));

文件夹链接

Image Relay API：文件夹链接

获取文件夹链接

$response = $client->getFolderLinks( array(
	'page' => 2,
));

获取文件夹链接

$response = $client->getFolderLink( array(
	'id' => 290503,
));

创建文件夹链接

$response = $client->createFolderLink( array(
	'folder_id' => 290503,
	'allows_download' => true,
	'expires_on' => '2015-07-15',
	'show_tracking' => true,
	'purpose' => 'Download for spring catalog images',
));

删除文件夹链接

$response = $client->deleteFolderLink( array(
	'id' => 290503,
));

受邀用户

Image Relay API：受邀用户

获取受邀用户

$response = $client->getInvitedUsers( array(
	'page' => 2,
));

获取受邀用户

$response = $client->getInvitedUser( array(
	'id' => 290503,
));

邀请新用户

$response = $client->inviteNewUser( array(
	'first_name' => 'First Name',
	'last_name' => 'Last Name',
	'email' => 'example@imagerelay.com',
	'company' => 'Image Relay',
	'permission_id' => 167,
));

删除受邀用户

$response = $client->deleteInvitedUser( array(
	'id' => 290503,
));

权限

Image Relay API：权限

获取权限

$response = $client->getPermissions( array(
	'page' => 2,
));

获取权限

$response = $client->getPermission( array(
	'id' => 290503,
));

快捷链接

Image Relay API：快捷链接

获取快捷链接

$response = $client->getQuickLinks( array(
	'page' => 2,
));

获取快捷链接

$response = $client->getQuickLink( array(
	'id' => 290503,
));

创建快捷链接

$response = $client->createQuickLink( array(
	'asset_id' => 290503,
	'purpose' => 'Download for spring catalog images',
));

删除快捷链接

$response = $client->deleteQuickLink( array(
	'id' => 290503,
));

上传链接

Image Relay API：上传链接

获取上传链接

$response = $client->getUploadLinks( array(
	'page' => 2,
));

获取上传链接

$response = $client->getUploadLink( array(
	'id' => 290503,
));

创建上传链接

$response = $client->createUploadLink( array(
	'folder_id' => 290503,
	'purpose' => 'Upload location for spring catalog images',
));

删除上传链接

$response = $client->deleteUploadLink( array(
	'id' => 290503,
));

用户

Image Relay API：用户

获取用户

$response = $client->getUsers( array(
	'page' => 2,
));

获取用户

$response = $client->getUser( array(
	'id' => 290503,
));

Webhooks

Image Relay API：Webhooks

获取Webhooks

$response = $client->getWebhooks();

获取Webhook

$response = $client->getWebhook( array(
	'id' => 290503,
));

创建Webhook

$response = $client->createWebhook( array(
	'resource' => 'file',
	'action' => 'created',
	'url' => 'https://www.example.com'
));

删除上传链接

$response = $client->deleteWebhook( array(
	'id' => 290503,
));

支持的Webhooks

$response = $client->getSupportedWebhooks();

关键词

Image Relay API：关键词

关键词集

获取关键词集

$response = $client->getKeywordSets( array(
	'page' => 2,
));

获取关键词集

$response = $client->getKeywordSet( array(
	'id' => 290503,
));

创建关键词集

$response = $client->createKeywordSet( array(
	'name' => 'Sample Keyword Set name',
));

更新关键词集

$response = $client->updateKeywordSet( array(
	'id' = > 244244,
	'name' => 'Sample Keyword Set name',
));

删除关键词集

$response = $client->deleteKeywordSet( array(
	'id' => 290503,
));

关键词

获取关键词

$response = $client->getKeywords( array(
	'keyword_set_id' => 2522,
));

获取关键词

$response = $client->getKeyword( array(
	'keyword_set_id' => 290503,
	'keyword_id' => 22323,
));

创建关键词

$response = $client->createKeyword( array(
	'keyword_set_id' => 22422,
	'name' => 'Sample Keyword Set name',
));

更新关键词

$response = $client->updateKeyword( array(
	'keyword_set_id' => 32454,
	'keyword_id' => 23224,
	'name' => 'Sample Keyword Set name',
));

删除关键词

$response = $client->deleteKeyword( array(
	'keyword_set_id' => 290503,
	'keyword_id' => 21424,
));

上传

Image Relay API：上传

createUploadJob

$uploadJob = $client->createUploadJob( array(
	'folder_id' => 291692,
	'file_type_id' => 1464,
	'files' => array ( array (
		'name' => 'two_frogs.jpg',
		'size' => filesize($_SERVER['DOCUMENT_ROOT'].'/two_frogs.jpg')
		)
	),
	'terms' => array ( array (
		'term_id' => '5802',
		'value' => 'Testing 123'
		)
	),
));

createFileChunk

$upload = $client->createFileChunk( array(
	'upload_job_id' => $uploadJob['id'],
	'file_id' => $uploadJob['files'][0]['id'],
	'chunk_id' => 1,
	'mimeType' => 'application/octet-stream',
	'data' => file_get_contents($_SERVER['DOCUMENT_ROOT'].'/two_frogs.jpg'),
));