Create. API

Get Started

See latest updates on the Change Log.

Information  
Current API Version 1
API Protocol HTTPS
API end point https://api.create.net/
Response methods JSON, JSONP
Authentication Basic tokens

The standard four REST verbs are used to access our resources:

Method Purpose
GET Use when requesting an existing resource
POST Use when creating a new resource
PUT Use when updating an existing resource
DELETE Use when deleting a resource

Getting Started

Testing

You can easily get started testing the API using your Development API Token available within your Create account (Account > Developers & API)

curl -i -H "X-Token: <development-api-token>" -H "X-Version: 1" https://api.create.net/test

Development Tokens won’t be able to be used in a production App however. You will need to create an API App and users will need to generate an Auth Token specifically for that App.

Help Guides

Apps

Every request to the API must include your registered App Token in an HTTP Header ‘X-AppToken’. Without this the API assumes that the Auth Token is a Development token.

You can create a new API App from your Create account;

  1. Login to your Create account
  2. Go to the ‘Account’ area in the top menu
  3. Click on ‘Developers & API’
  4. Click Create App

Once you App has been created, you can generate an Auth Token by adding the App to the account’s Connections. Continue reading for more information…

Authentication

Auth Tokens are linked to a single Create account and API App, and must be sent with every api request as an HTTP Header called ‘X-Token’.

You can generate a new Auth Token from your Create account;

  1. Login to your Create account
  2. Go to the ‘Account’ area in the top menu
  3. Click on the ‘Connections’ link.
  4. Click ‘Add Account’ and click on the required API App

You will now be provided with an Auth Token to be sent along side the App Token.

Requests must be sent with an x-Version=1 header

X-Token=<auth-token>
X-AppToken=<app-token>
X-Version=1

Input with no token header

GET 	https://api.create.net/test

Response

Status: 401 No authorisation token
{
  "error": "No authorisation token"
}

About Request and Response Formats

Requests and responses can be provided in JSON. Set the HTTP Accept header to specify the response format and the HTTP Content-Type header to specify the request format.

JSON

Accept: application/json
Content-Type: application/json

JSONP

Accept: application/javascript
X-JSONP-Callback: my_function_name
Content-Type: application/javascript

Sorting

By default, requests returning multiple items are ordered chronologically in descending order.

[
    { ID: 5 },
    { ID: 4 },
    { ID: 3 }
]

You can change the direction of sorting as well as which property is being used for sorting using the following parameters;

Parameter Possible Values Default Value
sort_direction ASC or DESC DESC
sort_property See the specific model ID 
// Order by average_rating to get the highest rated first
GET		/products?sort_direction=desc&sort_property=average_rating

Pagination

API requests that returns multiple items, such as listing orders, will be paginated (default to 25 items per page). In order to alter the number of records returned per page, a client can provide the per_page parameter (limited to 100 items per page).

To get the next page of data, you can provide the page parameter;

// Get records from 25 to 50
GET		/orders?page=2&per_page=25

If you are sorting by the ID (which is default) you can optionally paginate using a specific ID by providing the last_id parameter. This would be the last ID of the previous page, or an ID to offset the request.

// Get records from 25 to 50
GET		/orders?last_id=25&per_page=25

Access Levels

** Currently not implemented **

Access to our resources is limited by user permissions. Resources are split into groups, you can request access to a whole group, or individual resources within a group. The minimum required access level is specified for each resource. The access levels are as follows:

- general
	- site_details
		- account_details
		- account_stats  
	- domains
		- domain_names
		- mail_alias
		- dns
	- website_stats  
- content  
	- pages
	- blogs
		- blog_posts
		- blog_categories
		- blog_comments
	- guestbooks
	- custom_forms  
	- widgets  
	- event_calendars  
	- html_fragments  
	- enquires  
- shop
	- products_and_categories  
		- products  
		- categories  
	- stock_control  
	- product_options  
	- orders_managment  
		- orders  
		- order_products
		- disptach_notes  
		- address_labels  
		- order_status  
	- postage_and_tax  
	- payment_gateways  
	- shop_sale  
	- customer_accounts  
	- import_export  
		- import  
		- export  
	- downloadables  
	- discount_codes  
	- product_search  
	- shop_reports
		- financial_reports  
		- product_reports