Source images are your original images you upload to Rokka. You should always select the highest quality you can, Rokka will take care of the rest. Usually it's best to use PNG files, as they are not compressed. Rokka handles PNG, JPG and GIF files in RGB only.
| Attribute | Description |
|---|---|
| organization | Name of the organization that the image belongs to |
| hash | Hash to access the image with, based on metadata |
| binary_hash | Hash of image binary data |
| user_metadata | Contains the following data set. Changing this will not alter the main hash identifying the image |
| name | Original filename |
| format | Original format |
| size | Size of images in bytes |
| width | Width of image in pixels |
| height | Height of image in pixels |
| dynamic_metadata | Can contain data that will alter the image identifying hash if altered |
| created | When this image was created |
| link | Backlink to itself, useful when you have lists or search by binary hash |
You can create a source image with a post to the /sourceimages route and your organization name. It's a simple post with the file data in the body.
In the following example, image.png is a image file in your current working directory and the organization is set to mycompany.
curl -X POST -F filedata=@image.png 'https://api.rokka.io/sourceimages/mycompany'
$client = \Rokka\Client\Factory::getImageClient('mycompany', 'apiKey', 'apiSecret');
$sourceImage = $client->uploadSourceImage(file_get_contents('image.png'), 'image.png');
var_dump($sourceImage);
It will return the same meta data as you get from retrieving a single image, with the only difference that it is wrapped in an array for future expansions of multi file uploads.
You can retrieve meta data about a source image by providing the identifying hash on the /sourceimages route.
In the following example the organization is set to mycompany and the hash is set to c412d8d6e4b9b7b058320b06972ac0ec72cfe6e5.
curl -X GET 'https://api.rokka.io/sourceimages/mycompany/c412d8d6e4b9b7b058320b06972ac0ec72cfe6e5'
$client = \Rokka\Client\Factory::getImageClient('mycompany', 'apiKey', 'apiSecret');
$sourceImage = $client->getSourceImage('c412d8d6e4b9b7b058320b06972ac0ec72cfe6e5');
var_dump($sourceImage);
An example response looks like following.
{
"organization": "mycompany",
"hash": "c412d8d6e4b9b7b058320b06972ac0ec72cfe6e5",
"binary_hash": "03b3e8a0bdd76ef55c021066642c9d2fa9c02799",
"static_metadata":
{
"name": "image1.png",
"format": "png",
"size": 131284,
"width": 800,
"height": 1160
},
"dynamic_metadata": { },
"created": "2015-08-24T12:17:12+0000",
"link": "/sourceimages/liip/c412d8d6e4b9b7b058320b06972ac0ec72cfe6e5"
}
To delete a source image, you do a delete call on the source images url.
In the following example the organization is set to mycompany and the hash is set to c412d8d6e4b9b7b058320b06972ac0ec72cfe6e5.
curl -X DELETE 'https://api.rokka.io/sourceimages/mycompany/c412d8d6e4b9b7b058320b06972ac0ec72cfe6e5'
$client = \Rokka\Client\Factory::getImageClient('mycompany', 'apiKey', 'apiSecret');
$isDeleted = $client->deleteSourceImage('c412d8d6e4b9b7b058320b06972ac0ec72cfe6e5');
var_dump($isDeleted);
Deleting a source image will not remove it from the cache. Access to it will fade out as the cache becomes stale. Any new access to a render of a deleted source image will result in a 404 error.
Note: If the image you try to delete does not exist, the API responds with a 404 status code. This 404 can be ignored, though it might indicate a logic error in the client application.
See searching for images for more details about how to get a list of your images.
You can limit the outputs of the list by using limit and offset parameters to page through them.
| Attribute | Description |
|---|---|
| binaryHash | SHA1 hash of the binary file, lowercase hex |
In the following example the organization is set to mycompany and the binary hash is set to 03b3e8a0bdd76ef55c021066642c9d2fa9c02799.
curl -X GET 'https://api.rokka.io/sourceimages/mycompany?binaryHash=03b3e8a0bdd76ef55c021066642c9d2fa9c02799'
$client = \Rokka\Client\Factory::getImageClient('mycompany', 'apiKey', 'apiSecret');
$sourceImage = $client->getSourceImage('03b3e8a0bdd76ef55c021066642c9d2fa9c02799', true);
var_dump($sourceImage);
The result is a list with one item in it if anything is found.
Should you have a need to download the source image again, you can do so, using this call. This is the only way to get the exact image back. Even if you choose "noop" as a stack operation, rokka will process the image which may alter it.
curl -X GET 'https://api.rokka.io/sourceimages/mycompany/c412d8d6e4b9b7b058320b06972ac0ec72cfe6e5/download'
It will return the binary data as the response and contain the name of the file in the header of the response.