EASELLY DESIGN SERVICE REST API
Easelly allows some of our largest partners white label our design services. The Easelly Design Order API facilitates this working relationship between both parties.
This REST API provides access in creating order, retrieving order status, updating order details, requesting revision, listing of orders and approving order per customer/partner.
Creating an API Key
Access to the API is available to all Easelly partners. To start the integration process with the Easelly Design Service, you must contact your account manager (support@easel.ly) and request an API Key.
Authentication
The API is secured with ApiKeyAuth. You must use your API Key to sign requests when accessing the API.
Making Requests
To make a request you simply need to point to https://www.easel.ly/. Also, each request must have the apiKey parameter which is equal to your account’s API key.
Response Code
Every request will return a JSON response or an error response.
200 Successful operation- returns data as JSON in the response body.401 Unauthorized- Invalid or absence of the apiKey parameter.404 Not Found- may return extra error description in response body.405 Not Allowed- using a non partner account will lead to HTTP response with code 405 “Your account must be partner to use API”.
Response Time and Rate Limit:
The average response time varies depending on the size of the data request. On the average, these are the calculated response time per endpoint:
| # | Endpoint | Response Time | Optimized Rate Limit |
|---|---|---|---|
| 1 | https://www.easel.ly/orders/id | 1-3 seconds / order | 5 orders / second |
| 2 | https://www.easel.ly/orders/list | 1-3 seconds / order | 5 orders / second |
| 3 | https://www.easel.ly/orders/getOrderStatus | 1-3 seconds / order | 5 orders / second | 4 | https://www.easel.ly/getDesignFiles | 1-3 seconds / order | 5 orders / second | 5 | https://www.easel.ly/orders/createOrder | 5-10 seconds / order | 5 orders / second | 6 | https://www.easel.ly/orders/updateorder | 5-10 seconds / order | 5 orders / second | 7 | https://www.easel.ly/orders/requestRevision | 5-10 seconds / order | 5 orders / second | 8 | https://www.easel.ly/orders/approveOrder | 1-3 seconds / order | 5 orders / second |