Getting Started

API Endpoint

https://designeditor-as-service.cloud/api/v2

All requests to the API require authorization. To authorize, pass the App ID and Secret key via the HTTP header.

Download the PHP API Library


	
curl \
-X POST https://designeditor-as-service.cloud/api/v2 \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \


//PHP example
require('{PATH_TO_PHP_LIBRARY}');	
$client = new DesignStudioPlatform\API('Your App ID','Your API Key');

Common Terms

UserID: Refers to the unique ID of your website/app user
ProjectID: Refers to the unique project id returned by the API
ServiceUserID: Refers to the unique user ID returned by the API

All response to the API are returned in JSON format

Rate Limiting


	
HTTP/1.1 200 OK
Date: Sun, 03 Apr 2022 16:45:47 GMT
X-Ratelimit-Limit: 50
X-Ratelimit-Remaining: 49
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

The Service places a limit of 50 requests per hour and 1 request per 10 seconds on all API. On each request, your current rate limit status is returned in the response headers. If you need higher rate limit, contact us for further review

Hotlinking

The API service does not encourage hotlinking. We advise that you cache all your responses. And any file download links returned by the API have a 1 hour lifetime therefore we require you proceed with download when you receive the data.

Paging


	
#Use the page offset to control result paging
curl \
-X POST https://designeditor-as-service.cloud/api/v2/app/user/{userID}/projects \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "pageoffset=1" \


	
{
	"total_pages": 25,
	"items": [...]
}

In a few cases where the endpoint returns a list of results, you can use the pageoffset key to specify the page to return . You can inspect the total_pages property returned by the endpoint to know how to control your paging.

API callback

Most of the API endpoints require that you provide the callback parameter. The callback is a valid URL that is called when the API task is completed. The endpoint response will be posted to the callback URL upon completion.
Below is the sample of the callback response in JSON format


	
{
	{
    "result": {
        "download": [
				{
					"size": "419430",
					"url": "Direct download url",
					"extension": "jpg",
				},
				{
					"size": "51943",
					"url": "Direct download url",
					"extension": "png",
				},
			]
		}
	}
}


	
//Handle callback response
//PHP example
//Retrive and save file to folder
// Validate the response

if(($_SERVER['REQUEST_METHOD']=='POST' and !empty($_POST['result']) and is_array($_POST['result']) and isset($_POST['result']['download']))==false){
	throw new Exception('Invalid request');
}
/** 
You can do other validation here
**/
	$dir = 'FOLDER' //Folder where to save files;
	$files =  $_POST['result']['download'];
	foreach($files as $i=>$e){
		$fp = fopen($e['url'],'r');
		if(!$fp)continue;
		$bufferSzie = '4194304' //4 MB;
		$newfile = $dir.'/photo-'.$i.'.'.$e['extension'];
		$fpout = fopen($newfile,'wb');
		if(!$fpout)continue;
		while(!feof($fp)){
			$out = fread($fp,$bufferSzie);
			fwrite($fpout,$out);
		}
		fclose($fp);
		fclose($fpout);
		/**
		Do what you want with the 
		retrived file ($newfile) here
		**/
	}
	die;
	


	
#Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/packages/create/blurimage \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "images[]={IMAGE_SOURCE} \
--data-urlencode "images[]={IMAGE_SOURCE} \
--data-urlencode "callback={VALID URL HERE}" \



//Make API call and specify callback option
$client->call('packages/create/blurimage',array(
'images'=>$client->files(array(
'{IMAGE SOURCE}',
'{IMAGE SOURCE}'
)),
'callback'=>'{VALID URL HERE}'
));

Error Codes



{
    "error": {
        "message": "Authentication failed",
        "status_code": 401
    }
}

We use conventional HTTP status codes to indicate the success or failure of an API request

Error Code	Meaning
200	Ok
401	Authentication failed
403	Forbidden request
404	Request call not found
202	Request could not return data
503	Internal error while processing request

API Reference

/app/info



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/app/info \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \



# PHP example
$client->call('app/info');

Get APP info

/app/user/{userID}



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/app/user/{userID} \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \



# PHP example
$client->call('app/user/{userID}');

Get basic user info

/app/user/{userID}/projects



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/app/user/{userID}/projects \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \



# PHP example
$client->call('app/user/{userID}/projects');

Returns all the projects owned by the specified user

/project/info/{projectID}



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/project/info/{projectID} \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \



# PHP example
$client->call('project/info/{projectID}');

Returns the metadata of the specified project

/project/delete/{projectID}



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/project/delete/{projectID} \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \



# PHP example
$client->call('project/delete/{projectID}');

Delete specified project

/project/export/{projectID}



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/project/export/{projectID} \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "format=png" \
--data-urlencode "prefill[layername]={IMAGE_SOURCE}" \



# PHP example
$client->call('project/export/{projectID}',array (
  'format' => 'png',
  'prefill' => 
  array (
    'layername' => $client->files("{IMAGE SOURCE}"),
  ),
));

Export specified project

PARAMETERS

Field	Type	Description
format	string	(Required) Output format
prefill layername	array string	(optional) Replace named media layers with new source

/packages/create/placeholder



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/packages/create/placeholder \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "width=500" \
--data-urlencode "height=500" \
--data-urlencode "text=This is placeholder" \



# PHP example
$client->call('packages/create/placeholder',array (
  'width' => '500',
  'height' => '500',
  'text' => 'This is placeholder',
));

Generates placeholder image

PARAMETERS

Field	Type	Description
width	string	(Required) Output width
height	string	(Required) Output height
text	string	(Optional) Custom text

/packages/create/qr-code



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/packages/create/qr-code \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "data=http://example.com" \
--data-urlencode "picture={IMAGE_SOURCE}" \



# PHP example
$client->call('packages/create/qr-code',array (
  'data' => 'http://example.com',
  'picture' => $client->files("{IMAGE SOURCE}"),
));

Generates custom QR code image

PARAMETERS

Field	Type	Description
data	string	(Required) Data to encode
picture	string	(Optional) Custom image to place on the center

/packages/create/3d-text



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/packages/create/3d-text \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "text=Example Text Here" \
--data-urlencode "width=500" \
--data-urlencode "height=500" \
--data-urlencode "depth=12" \
--data-urlencode "depthcolor=grey" \
--data-urlencode "direction=left-top" \
--data-urlencode "colors[]=black" \
--data-urlencode "colors[]=white" \
--data-urlencode "background=transparent" \
--data-urlencode "contour[size]=2" \
--data-urlencode "contour[color]=white" \



# PHP example
$client->call('packages/create/3d-text',array (
  'text' => 'Example Text Here',
  'width' => '500',
  'height' => '500',
  'depth' => '12',
  'depthcolor' => 'grey',
  'direction' => 'left-top',
  'colors' => 
  array (
    0 => 'black',
    1 => 'white',
  ),
  'background' => 'transparent',
  'contour' => 
  array (
    'size' => '2',
    'color' => 'white',
  ),
));

Generates 3D text

PARAMETERS

Field	Type	Description
text	string	(Required) Text to convert to 3D
width	string	(Required) Output width
height	string	(Required) Output height
depth	string	(Optional) Specifies the amount of 3D depth
depthcolor	string	(Optional) Specifies 3D color
direction	string	(Optional)
colors	array	(Required) Specifies text gradient color
background	string	(Optional) Sepcifies background color
contour size color	array numeric string	(Optional) Specifies contour stroke size (Optional)) Specifies contour stroke color

/packages/create/product-box



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/packages/create/product-box \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "image={IMAGE_SOURCE}" \
--data-urlencode "width=500" \



# PHP example
$client->call('packages/create/product-box',array (
  'image' => $client->files("{IMAGE SOURCE}"),
  'width' => '500',
));

Generates product box/software box design

PARAMETERS

Field	Type	Description
image	string	(Required) Design to use for the process
width	string	(Required) Output dimension

/packages/create/instagram-puzzle



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/packages/create/instagram-puzzle \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "image={IMAGE_SOURCE}" \



# PHP example
$client->call('packages/create/instagram-puzzle',array (
  'image' => $client->files("{IMAGE SOURCE}"),
));

Generate instagram puzzle from photo

PARAMETERS

Field	Type	Description
image	string	(Required) Image source to process

/packages/create/photo-puzzle



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/packages/create/photo-puzzle \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "image={IMAGE_SOURCE}" \
--data-urlencode "columnsize=250" \
--data-urlencode "rows=3" \



# PHP example
$client->call('packages/create/photo-puzzle',array (
  'image' => $client->files("{IMAGE SOURCE}"),
  'columnsize' => '250',
  'rows' => '3',
));

Generates custom photo puzzle

PARAMETERS

Field	Type	Description
image	string	(Required) Image to process
columnsize	string	(Required) Dimension of each column
rows	string	(Required) Maximun number of rows

/packages/create/photo-collage



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/packages/create/photo-collage \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "Images[]={IMAGE_SOURCE}" \
--data-urlencode "bg=transparent" \
--data-urlencode "columnsize=250" \
--data-urlencode "rows=3" \
--data-urlencode "gap=0" \
--data-urlencode "frame[size]=1" \
--data-urlencode "frame[color]=black" \



# PHP example
$client->call('packages/create/photo-collage',array (
  'Images' => 
  array (
    0 => $client->files("{IMAGE SOURCE}"),
  ),
  'bg' => 'transparent',
  'columnsize' => '250',
  'rows' => '3',
  'gap' => '0',
  'frame' => 
  array (
    'size' => '1',
    'color' => 'black',
  ),
));

Generates collage from pictures

PARAMETERS

Field	Type	Description
Images	array	(Required) List of image sources to process
bg	string	(Optional) Output background color
columnsize	string	(Required) Size of each column on the collage
rows	string	(Required) The number of rows to generate
gap	string	(Optional) Used to specify column spacing
frame size color	array numeric string	(Optional) Used to specify column border size (Optional) Specify column border color

/packages/create/cd-cover



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/packages/create/cd-cover \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "image={IMAGE_SOURCE}" \
--data-urlencode "size=500" \
--data-urlencode "background=transparent" \
--data-urlencode "shadow=true" \



# PHP example
$client->call('packages/create/cd-cover',array (
  'image' => $client->files("{IMAGE SOURCE}"),
  'size' => '500',
  'background' => 'transparent',
  'shadow' => 'true',
));

Generates custom CD cover design

PARAMETERS

Field	Type	Description
image	string	(Required) Cover design image
size	string	(Required) Output width
background	string	(Optional) Output background color
shadow	string	(Optional) Specify whether to apply shadow on design

/packages/create/blurimage



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/packages/create/blurimage \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "images[]={IMAGE_SOURCE}" \



# PHP example
$client->call('packages/create/blurimage',array (
  'images' => 
  array (
    0 => $client->files("{IMAGE SOURCE}"),
  ),
));

Generate blurred version of images

PARAMETERS

Field	Type	Description
images	array	(Required) List of images to process. Maximum of 50 images supported

/photo/adjust



# Curl example
curl \
-X POST https://designeditor-as-service.cloud/api/v2/photo/adjust \
-H 'clientID=Your App ID' \
-H 'apikey=Your API Key' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode "images[]={IMAGE_SOURCE}" \
--data-urlencode "format=png" \
--data-urlencode "options[blur]=5" \
--data-urlencode "options[rotate]=90" \
--data-urlencode "options[sharpen]=10" \
--data-urlencode "options[greyscale]=0" \
--data-urlencode "options[saturation]=1" \
--data-urlencode "options[contrast]=10" \
--data-urlencode "options[hue]=10" \
--data-urlencode "options[brightness]=1.5" \
--data-urlencode "options[flip][horizontal]=1" \
--data-urlencode "options[flip][vertical]=1" \
--data-urlencode "options[crop]=100x100+0+12" \
--data-urlencode "options[resize]=250x250" \



# PHP example
$client->call('photo/adjust',array (
  'images' => 
  array (
    0 => $client->files("{IMAGE SOURCE}"),
  ),
  'format' => 'png',
  'options' => 
  array (
    'blur' => '5',
    'rotate' => '90',
    'sharpen' => '10',
    'greyscale' => '0',
    'saturation' => '1',
    'contrast' => '10',
    'hue' => '10',
    'brightness' => '1.5',
    'flip' => 
    array (
      'horizontal' => '1',
      'vertical' => '1',
    ),
    'crop' => '100x100+0+12',
    'resize' => '250x250',
  ),
));

Batch photo manipulation

PARAMETERS

Field	Type	Description
images	array	(Required) List of images to process. Maximum of 50 images supported
format	string	(Optional) Output format
options blur rotate sharpen greyscale saturation contrast hue brightness flip crop resize	array numeric numeric numeric numeric numeric numeric numeric numeric array string string