If you would like to contribute to the project please fork the repo and create a pull request with your work. Documentation will be updated as end points are added.
We recommend using composer to manage dependencies and installation of the Image Relay API PHP library. If you are unfamiliar with composer you can read about installation into your application here - Composer Install How To
$ php composer.phar require imagerelay/imagerelay-phpTo use the library you only need to have an Image Relay account with proper permissions to complete the API actions. You will need to require once the vender/autoload.php file provided by composer.
Don't forget to change imagerelay_url to use your own subdomain or custom 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',
));
?>When authorizing with oauth you will need to use one of the many existing libraries available to retrieve your oauth access token. The Image Relay API adheres to oauth standars for authentication.
Don't forget to change imagerelay_url to use your own subdomain or custom 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',
));
?> $response = $client->getFiles( array(
'folder_id' => 8363117,
'page' => 2,
)); $response = $client->getFile( array(
'id' => 8363117,
)); $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'
));$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',
));$response = $client->getFileTypes();$response = $client->getFileType( array(
'id' => 290503,
));$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: Invited Users
$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,
));$response = $client->getPermissions( array(
'page' => 2,
));$response = $client->getPermission( array(
'id' => 290503,
));$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,
));$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,
));$response = $client->getUsers( array(
'page' => 2,
));$response = $client->getUser( array(
'id' => 290503,
));$response = $client->getWebhooks();$response = $client->getWebhook( array(
'id' => 290503,
));$response = $client->createWebhook( array(
'resource' => 'file',
'action' => 'created',
'url' => 'https://www.example.com'
));$response = $client->deleteWebhook( array(
'id' => 290503,
));$response = $client->getSupportedWebhooks();$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,
));$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'
)
),
));$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'),
));