Utilising the AOD API, third party front-end applications and/or back-end systems can connect and utilise the Cloudsto.re AOD services. The following diagram shows the flow of API calls and processes involved in running an AOD enabled front-end Client application.

This documentation describes the Cloudsto.re new Art-on-Demand Web Services API

Version 2.0 (Released Jan 2019)

Accessing the API

Make all requests to: https://api.cloudsto.re/aod

 
TLS 1.2 (or better) encryption is required for all calls to all the Cloudsto.re Web Services. TLS version 1.1 and earlier are not supported.

Cloudsto.re API

The Cloudsto.re API is designed as RESTful API. All API calls are implemented as httpMethod: POST. The HTTP response codes 200 is success responses, all other response codes are errors. Data will only be returned for HTTP response code 200. Error descriptions can be obtained from the response body. See Error handling section for further information.

Request Data

All request data sent to the Cloudsto.re API must be in JSON objects. See the section for each API call for the full details of the request data format. The content-type header should be set accordingly to application/x-www-form-urlencoded .

Return Data

Return data from the API is in JSON objects by default. See the section for each API call for the full details of the return values within the response object. JSON is the recommended data format for returned data and accept header should be set to either: application/json or */*. (XML format data returns can be requested by setting the accept header to application/xml, This feature is currently experimental and not fully tested)

Authentication

Each API call should contain an API key for authentication. API keys are created when you are registered to use the service. See Core API guide for further information.

Request account information for this business/user

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA"
}

Parameters

Response

{
   "CurrencySymbol":"£",
   "FactorB":1.00,
   "FactorP":1.00,
   "ExchangeRate":1.00,
   "CreditControl" : true,
   "CreditBalance" : 122.49
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/currency",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/currency

Request a list of all account transactions information associated with this user account under credit control. Optionally state a DateFrom and/or DateTo, for transactions after  and/or before a certain date.

Total, Start and Quantity variables are used for pagination purposes. Start is representing the index of the first transaction, and as a zero-based index, the default value 0 represents the first transaction. Note that Total represents the number of all the transactions matching the input query, and may be different to the number of transactions actually returned which relies upon the values used for Start and Quantity.

For example you wish to display only 20 transactions per page, you would make a first query with Quantity=20 and Start=0 (start can be omitted as 0 is the default value), and the value of Total would help you calculate the number of pages you need to handle all transactions.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "DateFrom" : 1541933250,  
  "DateTo" : 0,   
  "Quantity" : 100,
  "Start" :  0
}

Parameters

Response

{  
   "Total": 2, 
   "Count": 2,
   "Transactions":[  
      {  
         "Date":"1546424017",
         "Event":"PRINT",
         "Reference":"JB-182",
         "Value": 34.23,
         "BalanceBefore": 432.00,
         "BalanceAfter": 397.77,
     }, 
     {           
         "Date":"1546434029",          
         "Event":"PURCHASE",          
         "Reference":"RIP190603-3320-85161",          
         "Value": 50.00,          
         "BalanceBefore": 397.77,          
         "BalanceAfter": 447.77,  
     },  
  ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/transactions",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Transactions, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/transactions

Request a list of all artists names from any publishers accessible for this account

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "PublisherID" : ["20", "4"]
}

Parameters

Response

{
   "Count":14,
   "Artists":[
      "ARVEE",
      "Alberto Valentini",
      "Andreas Alba",
      "Andr Polan",
      "Anji Allen",
      "Ake Ibe",
      "Anne Bernard",
      "Anne VilsbÃll",
      "Annette Schmucker",
      "Annie Manero",
      "Antonio Poioumen",
      "Assaf Frank",
      "Aurlien Terrible",
      "Ayline Olukman"
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/artists",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,
                          "PublisherID" : ["20"]}),    
    success: function(response) {
          $.each(response.Artists, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/artists

Request a list of all category names from any publishers accessible for this account

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "PublisherID" : ["20", "4"]
}

Parameters

Response

{
   "Count":15,
   "Categories":[
      "Animals",
      "Celebrities",
      "Hobbies",
      "Pop Art",
      "Typography",
      "Abstract Painting",
      "Abstract Reality",
      "Around the Kitchen",
      "Around the World",
      "Beach & Sea",
      "Modern Art",
      "Music & Dance",
      "New York"
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/categories",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,
                          "PublisherID" : ["20"]}),    
    success: function(response) {
          $.each(response.Categories, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/categories

Request a list of all gallery names accessible for this account

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA"
}

Parameters

Response

{
   "Count":3,
   "Galleries":[
      "My Gallery",
      "Wedding",
      "Holiday"
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/galleries",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Categories, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/galleries

Request remove from database of a single gallery associated with this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Gallery" : "My Gallery"
}

Parameters

Response

{ 
   "Count": 2, 
   "Galleries" : [ 
       "Wedding", 
       "Holiday" 
   ] 
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/galleries/remove",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"Gallery":"My Gallery"}),    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","Gallery":"My gallery"}' \
      -X POST https://api.cloudsto.re/aod/galleries/remove

Update or add a new Gallery associated with this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Gallery" : "My Gallery",
  "ImageID" : [
    "25564",
    "25565",
    "25566",
    "25567"
  ]
}

Parameters

Response

{ 
   "Count": 3, 
   "Galleries" : [ 
       "My Gallery",
       "Wedding", 
       "Holiday" 
   ] 
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/galleries/update",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"Gallery":"My Gallery","ImageID":["25564","25565"]}),    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","Gallery":"My gallery"}' \
      -X POST https://api.cloudsto.re/aod/galleries/update

Add new images to an existing Gallery associated with this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Gallery" : "My Gallery",
  "ImageID" : [
    "25564",
    "25565",
    "25566",
    "25567"
  ]
}

Parameters

Response

{ 
   "Count": 3, 
   "Galleries" : [ 
       "My Gallery",
       "Wedding", 
       "Holiday" 
   ] 
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/galleries/update/add",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"Gallery":"My Gallery","ImageID":["25564","25565"]}),    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","Gallery":"My gallery"}' \
      -X POST https://api.cloudsto.re/aod/galleries/update/add

Delete images from an existing Gallery associated with this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Gallery" : "My Gallery",
  "ImageID" : [
    "25564",
    "25565",
    "25566",
    "25567"
  ]
}

Parameters

Response

{ 
   "Count": 3, 
   "Galleries" : [ 
       "My Gallery",
       "Wedding", 
       "Holiday" 
   ] 
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/galleries/update/delete",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"Gallery":"My Gallery","ImageID":["25564","25565"]}),    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","Gallery":"My gallery"}' \
      -X POST https://api.cloudsto.re/aod/galleries/update/delete

×

This call is now deprecated, use /account call to get the same information

Request currency information for this account

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA"
}

Parameters

Response

{
   "CurrencySymbol":"£",
   "FactorB":1.00,
   "FactorP":1.00,
   "ExchangeRate":1.00
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/currency",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/currency

Request a list of images available with this account based on filter provided.

Total, Start and Quantity variables are used for pagination purposes. Start is representing the index of the first image, and as a zero-based index, the default value 0 represents the first image. Note that Total represents the number of all the images matching the input query, and may be different to the number of images actually returned which relies upon the values used for Start and Quantity. 

For example you wish to display only 20 images per page, you would make a first query with Quantity=20 and Start=0 (start can be omitted as 0 is the default value), and the value of Total would help you calculate the number of pages you need to handle all images. 

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "PublisherID" : ["20", "4"],
  "ImageID" : [],
  "Artist" : [],
  "Category" : [], 
  "Keyword" : [],
  "Orientation" : [],
  "Date" : 0,
  "WebClient" : 1,
  "Quantity" : 100,
  "Start" : 0,
  "Locale" : "en"
}

Parameters

Response

{
   "Total":1,
   "Count":1,
   "Images":[
      {
         "ImageID":"8204",
         "Reference":"PJ-528-64",
         "PublisherID":"15",
         "Artist":"Arlen Passang",
         "Category": "Animals",
         "ItemName":"Lion",
         "Width":7016,
         "Height":9933,
         "CostValueSquareMilN":10,
         "FixedCostValue":0,
         "S3Path":"15//AOD/Publisher-15/Images/PJ-528-64.jpg",
         "PrintLimit":-1,
         "LimitedEdition":-1,
         "DpiX":762,
         "Crop":true,
         "Mirror":true,
         "Move":true,
         "Rotate":true,
         "RangeZoomMax":210,
         "RangeZoomMin":10,
         "MaxPrintSize":-1,
         "PremiumFactor":1,
         "ThumbPath":"https://s3-eu-west-1.amazonaws.com/AOD/Pub15/Thumbs/8204.jpg",
         "Tags":[ 
            "animal", 
            "wildlife", 
            "lion" 
         ],
         "Tags_en": [ 
            "animal", 
            "wildlife", 
            "lion" 
         ] 
      }
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/images",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Images, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/images

Request a list of images available with this gallery based on filter provided.

Total, Start and Quantity variables are used for pagination purposes. Start is representing the index of the first image, and as a zero-based index, the default value 0 represents the first image. Note that Total represents the number of all the images matching the input query, and may be different to the number of images actually returned which relies upon the values used for Start and Quantity.

For example you wish to display only 20 images per page, you would make a first query with Quantity=20 and Start=0 (start can be omitted as 0 is the default value), and the value of Total would help you calculate the number of pages you need to handle all images.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Gallery" : "My Gallery",
  "PublisherID" : ["20", "4"],
  "ImageID" : [],
  "Artist" : [],
  "Category" : [], 
  "Keyword" : [],
  "Orientation" : [],
  "Date" : 0,
  "WebClient" : 1,
  "Quantity" : 100,
  "Start" : 0,
  "Locale" : "en"
}

Parameters

Response

{
   "Total":1,
   "Count":1,
   "Images":[
      {
         "ImageID":"8204",
         "Reference":"PJ-528-64",
         "PublisherID":"15",
         "Artist":"Arlen Passang",
         "Category": "Animals",
         "ItemName":"Lion",
         "Width":7016,
         "Height":9933,
         "CostValueSquareMilN":10,
         "FixedCostValue":0,
         "S3Path":"15//AOD/Publisher-15/Images/PJ-528-64.jpg",
         "PrintLimit":-1,
         "LimitedEdition":-1,
         "DpiX":762,
         "Crop":true,
         "Mirror":true,
         "Move":true,
         "Rotate":true,
         "RangeZoomMax":210,
         "RangeZoomMin":10,
         "MaxPrintSize":-1,
         "PremiumFactor":1,
         "ThumbPath":"https://s3-eu-west-1.amazonaws.com/AOD/Pub15/Thumbs/8204.jpg",
         "Tags":[ 
            "animal", 
            "wildlife", 
            "lion" 
         ] 
      }
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/images/gallery",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"Gallery":"My Gallery"}),    
    success: function(response) {
          $.each(response.Images, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","Gallery":"My Gallery"}' \
      -X POST https://api.cloudsto.re/aod/images

Request a list of top/trending keywords

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA"
}

Parameters

Response

{
   "Count":10,
   "Keywords":[
      "abstract",
      "flowers",
      "photography",
      "sea",
      "cities",
      "sky",
      "animal",
      "music",
      "sun",
      "woman"
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/images/keywords",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Keywords, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/images/keywords

Request pricing information for an image based  on size, and media information provided.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "PublisherID" : "20",
  "ImageID" : "IM-126",
  "ProfileName" : "Premium Glossy Paper 720x1440dpi",
  "FrameWidth" : 200,
  "FrameHeight" : 200, 
  "BorderSize" : 10,
  "Quantity" : 1,
  "PicFrame" : "1235673409876"
}

Parameters

Response

{
   Currency: "£"
   Price: 8.97,
   Royalty: 9.8,
   MediaCost: 0,
   CreditControl: true,
   CreditBalance: 230.56
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/images/price",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({
       “APIKey”:“x-a3A1qLrXStYDgThU3dfA”,
       "PublisherID" : "20",
       "ImageID" : "IM-654",
       "FrameWidth" : 250.50,
       "FrameHeight" : 300.00,
       "ProfileName" : "Premium Luster 1440"
    }),    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","PublisherID" : "20","ImageID" : "IM-654","FrameWidth" : 250.50,"FrameHeight" : 300.00,"ProfileName" : "Premium Luster 1440"}' \
      -X POST https://api.cloudsto.re/aod/images/price

Request thumbnail data for an image. Image thumbnail data is returned as base64 encoded string data. The size of the returned data is limited to 10MB maximum. Due to overhead cost of calling an API (>1s), to access the thumbnail you should use the ThumbPath URL returned with /images data endpoints. Only use /images/thumbnail where you may want access to the data directly maybe to avoid CORS issues.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "PublisherID" : "20",
  "ImageID" : "IM-126",
}

Parameters

Response

{/9j/4AAQSkZJRgABAQEBaAFoAAD/7R0eUGhvdG9zaG9wIDMuMAA4QklNBAQAAAAAAHwcAVoAAxslRxwCAAACAAIcAngAaERhdGVpZm9ybWF0OiBFUFMNRXJ6ZXVndCB2b246IEFkb2JlIFBob3Rvc2hvcCBWZXJzaW9uIDYuMC4xDURhdHVtOiAyOS4xMS4yMDAxIDE5OjA0IFVocg1OYW1lOiBJRzM3NC5lcHMNOEJJTQQlAAAAAAAQQyyHTD1qr1DNRpdmLotxeDhCSU0EOgAAAAAAkwAAABAAAAABAAAAAAALcHJpbnRPdXRwdXQAAAAFAAAAAENs......}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/images/thumbnail",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({
       “APIKey”:“x-a3A1qLrXStYDgThU3dfA”,
       "PublisherID" : "20",
       "ImageID" : "IM-654"
    }),    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","PublisherID" : "20","ImageID" : "IM-654"}' \
      -X POST https://api.cloudsto.re/aod/images/thumbnail

Request a list of all jobs information associated with this account. Optionally state a Date, for jobs after a certain date.

Total, Start and Quantity variables are used for pagination purposes. Start is representing the index of the first job, and as a zero-based index, the default value 0 represents the first job. Note that Total represents the number of all the jobs matching the input query, and may be different to the number of jobs actually returned which relies upon the values used for Start and Quantity.

For example you wish to display only 20 jobs per page, you would make a first query with Quantity=20 and Start=0 (start can be omitted as 0 is the default value), and the value of Total would help you calculate the number of pages you need to handle all jobs.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Date" : 1541933250,
  "Quantity" : 100,
  "Start" :  0
}

Parameters

Response

{  
   "Total": 2, 
   "Count": 2,
   "Jobs":[  
      {  
         "JobID":"JB-180",
         "Status":"submitted",
         "ImageID":"7654",
         "PublisherID":"15",
         "ServerID": "32",
         "QueueName":"Essex Epson 8000",
         "MediaID":"Premium Glossy Paper 720x1440 DPI",
         "Date":1546424017,  
         "LastStatusChangeDate":1546424017,
         "TotalPrice":19.85,
         "Quantity":1,
         "FrameWidth":800,
         "FrameHeight":800, 
         "SizeW":800,
         "SizeH":800,
         "CanvasBorderSize":0,
         "OuterBorder1Size":0,
         "OuterBorder2Size":0,
         "InnerBorder1Size":0,
         "InnerBorder2Size":0,
         "OrderRef":"John Reorder",
         "Premium":true,
         "CropMarks":false,
         "BoundaryMarks":false,
         "Proof":false,
         "JobLabel":true
      },
      {            
          "JobID":"JB-185",          
          "Status":"submitted",          
          "ImageID":"9950",          
          "PublisherID":"15",          
          "ServerID": "32",          
          "QueueName":"Essex HP 20K",          
          "MediaID":"Glossy Paper 720DPI",   
          "Date":1546574017, 
          "LastStatusChangeDate":1546574017, 
          "TotalPrice":11.06,
          "Quantity":1,
          "FrameWidth":800,
          "FrameHeight":600, 
          "SizeW":800,
          "SizeH":600,
          "CanvasBorderSize":0,
          "OuterBorder1Size":0,
          "OuterBorder2Size":0,
          "InnerBorder1Size":0,
          "InnerBorder2Size":0, 
          "OrderRef":"Tue-132",
          "Premium":false,
          "CropMarks":true,
          "BoundaryMarks":false,
          "Proof":false,
          "JobLabel":true
     }, 
  ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/jobs",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Templates, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/jobs

Request a single job information associated with this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "JobID" : "JB-180"
}

Parameters

Response

{  
   "Total": 1, 
   "Count":1,
   "Jobs":[  
      {  
         "JobID":"JB-180",
         "Status":"submitted",
         "ImageID":"7654",
         "PublisherID":"15",
         "ServerID": "32",
         "QueueName":"Essex Epson 8000",
         "MediaID":"Premium Glossy Paper 720x1440 DPI",
         "Date":1546424017,  
         "LastStatusChangeDate":1546424017,
         "TotalPrice":19.85,
         "Quantity":1,
         "FrameWidth":800,
         "FrameHeight":800, 
         "SizeW":800,
         "SizeH":800,
         "CanvasBorderSize":0,
         "OuterBorder1Size":0,
         "OuterBorder2Size":0,
         "InnerBorder1Size":0,
         "InnerBorder2Size":0,
         "OrderRef":"John Reorder",
         "Premium":true,
         "CropMarks":false,
         "BoundaryMarks":false,
         "Proof":false, 
         "JobLabel":true
      }
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/jobs/info",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"JobID":"JB-180"}),    
    success: function(response) {
          $.each(response.Templates, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","JobID":"JB-180"}' \
      -X POST https://api.cloudsto.re/aod/jobs/info

Submit a job with Dynamic Photo-Pack specification data.

All job specification output consists of a Viewport Frame and an Image Box. The  ViewPort Frame is the printed face and the area which will be charged for image royalty. The location of the image relative to the Viewport Frame determines what area of the image is printed. The Viewport Frame Origin is set as 0,0. The Image Box Origin (ImageX, ImageY) is set as relative to Viewport Frame Origin (0,0). The coordinates can be positive or negative.  Positive X is for images places to the right of the Frame origin whilst negative X is for images to the left of the Frame origin outside the Viewport. Positive Y is for images places to the below of the Frame origin whilst negative Y is for images to the above of the Frame origin outside the Viewport.For poster printing specify the size of the Viewport Frame (FrameWidth, FrameHeight) and the location of the Image (ImageX, ImageY) relative to the origin of the Viewport Frame (0,0). You can also specify a scale (ImageScale) to size the image. Poster prints can also have an additional outer box with specified width and colour, using the OuterBoxBorder parameters.

The job can have multiple borders both inside and outside the Viewport Frame. These borders plus an outer margin are defined through various job parameters. the following diagram shows all the borders and margins available  for a job with default values of zero for all.

For Canvas printing the Viewport Frame size (FrameWidth, FrameHeight) specifies the size of Canvas front face. The Image location (ImageX, ImageY) and size (ImageScale) determines what area of the image is mapped on to the Canvas face. The Canvas border width and bleed type are specified using various CanvasBorder parameters.

The Dynamic Photo-Pack specification using the Viewport Frame and Image Box can be used to design: Poster, Original, Fit, Fill or any free layout required.

Special Fit/Fill Jobs

A special Fit or Fill job can be selected without specifying the image size and position. When fit or fill is selected the system will adjust the image size and position automatically to achieve the best fit or fill for the stated FrameWidth and FrameHight.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "PublisherID" : "20",
  "ImageID" : "ID-3456",
  "ServerID" : "Server-56",
  "QueueName" : "Epson-8000-Essex, 
  "ProfileName" : "Enhanced Photo Glossy 1440",
  "FrameWidth" : 800,
  "FrameHeight" : 800,
  "ImageX" : 0,
  "ImageY" : 0,
  "ImageScale" : 1,
  "FitFill" : fit,
  "ImageRotation" : 0,
  "ImageMirror" : "none",
  "Quantity" : 1,
  "OuterBorder1Size" : 0,
  "OuterBorder2Size" : 0,
  "InnerBorder1Size" : 0,
  "InnerBorder2Size" : 0,
  "OuterBorder1Colour" : { "r" : 255, "g" : 255, "b" :255 },  
  "OuterBorder2Colour" : { "r" : 255, "g" : 255, "b" :255 },
  "InnerBorder1Colour" : { "r" : 255, "g" : 255, "b" :255 }, 
  "InnerBorder2Colour" : { "r" : 255, "g" : 255, "b" :255 },    
  "CanvasBorderSize" : 0,
  "CanvasBorderType" : "mirror",
  "CanvasCutLineType" : "none",
  "CanvasBorderColour : { "r" : 255, "g" : 255, "b" :255 },
  "CropMarks" : false,
  "BoundaryMarks : true,
  "JobNest" : false,
  "JobCut" : false,
  "JobLabel" : true,
  "Notes" : "Urgent Job",
  "OrderRef" : "QJ-45674-PT",
  "JobHold" : false,
  "OuterLeftMargin" : 0,
  "OuterRightMargin" : 0,
  "OuterTopMargin" : 0,
  "OuterBottomMargin" : 0,
  "JobRotation" : 0,
  "JobMirror" : "none",
  "JobJustification" : "left",
  "JobShiftX : 0,
  "JobShiftY : 0,
  "Proof" : false,
  "PicFrame: "1234687549075",
  "JobPriority" : "high",
  "ClientOrigin" : "Rosetta",
}

Parameters

Response

{
   "Count": 1,
   "JobID": ["JB-132"]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/jobs/submit",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,
                          "PublisherID" : "20",
                          "ImageID" : "2572",
                          "ServerID" : "Server-45",
                          "QueueName" : "Essex P8000",
                          "ProfileName" : "Glossy 1440",
                          "FrameWidth" :  800,
                          "FrameHeight" : 800
    }),    
    success: function(response) {
          $.each(response.JobID, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{“APIKey”:“x-a3A1qLrXStYDgThU3dfA”, \
           "PublisherID":"20", \
           "ImageID":"2572", \
           "ServerID":"Server-45", \
           "QueueName":"Essex P8000", \
           "ProfileName":"Glossy 1440", \
           "FrameWidth":800, \
           "FrameHeight":800}' \
      -X POST https://api.cloudsto.re/aod/jobs/submit

Request a list of all media information associated with this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Locale" : "en"
}

Parameters

Response

{  
   "Count":1,
   "Medias":[  
      {  
         "ProfileName":"Premium Glossy Paper 720x1440dpi",
         "WebName":"Premium Glossy",
         "MaxWidth":500,
         "UnitCost":"0.00",
         "UnitFixedCost":"0.00",
         "MediaFactor":"1.00",
         "AdditionalUnitCost":"0.00",
         "AdditionalUnitFixedCost":"0.00",
         "Premium":false,
         "Server":{  
            "ServerID":"35",
            "QueueName":"LONDON CLOUD Q",
            "MaxWidth":500,
            "PrinterType": 0,
            "PrinterModel": 82
         }
      }
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/medias",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Medias, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/medias

Request a list of all picture frames information associated with this account. Only active picframes are returned.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Locale" : "en"
}

Parameters

Response

{  
   "Count":2,
   "PicFrames":[  
      {  
         "PicFrameID":"1545213456004",
         "WebName":"Gold 2-inch",
         "ThumbPath": "https://s3-eu-west-1.amazonaws.com/Thumbs/1545213456004"
      },
      {  
         "PicFrameID":"1545315395547",
         "WebName":"Black Embossed",
         "ThumbPath":"https://s3-eu-west-1.amazonaws.com/Thumbs/1545315395547"
      }
  ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/picframes",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.PicFrames, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/picframes

Request information on a single picframe associated with this account. Information returned if the picframe is active.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "PicFrameID" : "1545213456004"
  "Locale" : "en" 
}

Parameters

Response

{  
   "Count":1,
   "PicFrames":[  
      {  
         "PicFrameID":"1545213456004",
         "WebName":"Gold 2-inch",
         "ThumbPath": "https://s3-eu-west-1.amazonaws.com/Thumbs/1545213456004"
      }  
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/picframes/info",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"PicFrameID" : "1545213456004"}),    
    success: function(response) {
          $.each(response.PicFrames, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","PicFrameID" : "1545213456004"}' \
      -X POST https://api.cloudsto.re/aod/picframes/info

Request remove from database of a single picframe associated with this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "PicFrameID" : "1545213456004"
}

Parameters

Response

{  
   "Message" : "PicFrame Removed"
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/picframes/remove",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"PicFrameID":"1545213456004"}),    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","PicFrameID":"1545213456004"}' \
      -X POST https://api.cloudsto.re/aod/picframes/remove

Add a new or update an existing picframe with information.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "PicFrameID" : "1545213456004",
  "WebName" : "Black Border 1-inch",
  "Active" : "true"
}

Parameters

Response

{
  PicFrameID : '1545213456004'
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/picframes/update",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"PicFrameID" : "1545213456004","WebName" : "Black Border 1-inch"}),    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","PicFrameID" : "1545213456004","WebName" : "Black Border 1-inch"}' \
      -X POST https://api.cloudsto.re/aod/picframes/update

Request a list of all publishers accessible for this account with their full details

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA"
}

Parameters

Response

{
   "Count":3,
   "Publishers":[
      {
         "ID":"1",
         "Name":"Imagesto.re"
      },
      {
         "ID":"19",
         "Name":"New Atelier"
      },
      {
         "ID":"4",
         "Name":"New Graphics"
      }
   ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/publishers",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Publishers, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/publishers

Request a list of all templates information associated with this account. Only active templates are returned.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "Locale" : "en"
}

Parameters

Response

{  
   "Count":2,
   "Templates":[  
      {  
         "TemplateID":"1545213456004",
         "WebName":"Framed Type A1",
         "Width":100,
         "Height":98.2,
         "CanvasBorderSize":10.3,
         "CanvasBorderType":"colour",
         "CanvasBorderColour":{"r":255,"g":255,"b":255},
         "OuterBorder1Size":0,
         "OuterBorder1Colour":{"r":255,"g":255,"b":255},
      },
      {  
         "TemplateID":"1545315395547",
         "WebName":"cloudstor",
         "Width":200,
         "Height":200,
         "CanvasBorderSize":0,
         "CanvasBorderType":"none",
         "CanvasBorderColour":{"r":255,"g":255,"b":255}
      }
  ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/templates",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”}),    
    success: function(response) {
          $.each(response.Templates, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA"}' \
      -X POST https://api.cloudsto.re/aod/templates

Request information on a single template associated with this account. Information returned if the template is active.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "TemplateID" : "1545213456004",
  "Locale" : "en"
}

Parameters

Response

{  
   "Count":1,
   "Templates":[  
      {  
         "TemplateID":"1545213456004",
         "WebName":"Framed Type A1",
         "Width":100,
         "Height":98.2,
         "CanvasBorderSize":10.3,
         "CanvasBorderType":"colour",
         "CanvasBorderColour":{"r":255,"g":255,"b":255}"
      }
  ]
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/templates/info",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"TemplateID":"1545213456004"}),    
    success: function(response) {
          $.each(response.Templates, function(index, value) {
               // process returns
          });
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","TemplateID":"1545213456004"}' \
      -X POST https://api.cloudsto.re/aod/templates/info

Request remove from database of a single template associated with this account.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "TemplateID" : "1545213456004"
}

Parameters

Response

{  
   "Message" : "Template Removed"
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/templates/remove",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"TemplateID":"1545213456004"}),    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","TemplateID":"1545213456004"}' \
      -X POST https://api.cloudsto.re/aod/templates/remove

Add a new or update an existing template with information.

Request 

{ 
  "APIKey": "x-a3A1qLrXStYDgThU3dfA",
  "TemplateID" : "1545213456004",
  "WebName" : "Stretched Border Canvas",
  "CanvasBorderType" : "colour",
  "CanvasBorderColour" : {"r":255,"g":255,"b":255}
}

Parameters

Response

{
  TemplateID : '1545213456004'
}

Parameters

JQuery Example

$.ajax({
    url: "https://api.cloudsto.re/aod/templates/update",
    contentType: 'application/x-www-form-urlencoded',
    dataType: 'json',
    type: 'POST', 
    data: JSON.stringify({“APIKey”:“x-a3A1qLrXStYDgThU3dfA”,"TemplateID" : "1545213456004","WebName" : "Stretched Border canvas"}),    
    success: function(response) {
               // process returns
    },
    error: function(err) {
               // handle error
    }
});

cURL Example

$curl -d '{"APIKey" : "x-a3A1qLrXStYDgThU3dfA","TemplateID" : "1545213456004","WebName" : "Stretched Border canvas"}' \
      -X POST https://api.cloudsto.re/aod/templates/update

Errors are returned as standard JSON objects using HTTP statusCode. With error status, the error message text can be obtained from the response body. The HTTP response code 200 is success responses, all other response codes are errors. Data will only be returned for HTTP response code 200.

{
    statusCode: 400,
    body: "Invalid Request"
}

HTTP Status Code

Transport Layer Security

TLS 1.2 (or better) encryption is required for all calls to the Cloudsto.re Web Services V2 APIs. TLS version 1.1 and earlier are no longer supported.

Image ID

In V1 Image ID was the the only required parameter to select a particular image. As from V2 you will need to include the PublisherID as well to identify a unique Image.

Thumbnail

In V1 there were two types of Thumbnails: small thumb and copyrighted larger thumb and both were available through an specific API call. In V2 we store only one thumbnail and additionally there is no specific separate API call to access the thumbnail as binary data. The new search Images API call includes a Thumb-path parameter for each image which contain the URL to the thumbnail file for the specified image.  The consuming application should track and handle the thumbnail from the image search data.

Response Data

Our V1 API returned data in XML or string format. We have changed the communication data into and returned from our API v2 to JSON. Using JSON ensure maximum flexibility in handling complex data structure and also is in line with standards web communication strategies. When porting to v2 we advise use of JSON in data communication. however for backward compatibility in most API calls you can request an XML data return instead. The XML data handling from v2 is not widely used by our clients and therefore is not fully field tested. We recommend porting your applications to handle JSON for better compatibility and performance as wll as future proofing your platform.

V1 End of Life

Support for API v1 will be maintained for present and will publish an End-of-life call, at least 6 months before withdrawing the service. However API v1 will no longer be developed or enhanced further and all new services will be introduced with API v2.