MENU

Authentication

We provide a very simple authentication method, that is suitable for connecting couriers, inventory systems, accounting systems, and connecting with other cloud services. We do not suggest you use this API for deploying phone apps or any software installed on customers devices. Having access to the API keys, potentially gives a user READ and WRITE access to all your website data via this method. 

New users are welcome to sample our api. Sending Email and Files endpoint is a privilege only for live customers. Rest all endpoints are available for sample.

Enabling the API / Obtaining Access Keys

To obtain API access keys, please...

  1. login to the CMS / Control Panel
  2. Click the Shop Setup button, or edit your target shopping page. 
  3. Click the API tab, or API's button.
  4. Scroll down and add the JSON api option.
  5. Click Enable API.
  6. An API ID and a API Key will be provided to you. The API ID identifies this instance of the integration, which identifies your website, and the default page for data creation (if page is not identified in the JSON data post)
  7. The API key can be changed to anything you wish.

End Points

This is our secure API URL:  https://api.website.world/webapps/api/... 

You can append any of our end points on the end, eg https://api.website.world/webapps/api/products

Some api end points may permit path info upon the end of the URL, eg for the requested ID, file path, etc. But please check invididual end points for allowable options.

Using the Access Keys 

You can provide the "apiID" and "apiKey" as either request headers or request parameters.

They can be GET or POST parameters. They can be POST parameters within a multipart form post also. 

We are also looking to provide an oAuth authentication method soon.

Posting JSON data

You can post your JSON payload inside a "data" request parameter...

Or you can set your header ContentType="text/json", with the content body being your JSON data

Alternatively, you may use a multipart form post content type, if you are uploading files with your API request.

Retrieving Data

You can use GET or POST to retrieve data, but GET makes more sense.

You can use Accept Header to retrieve data in JSON or XML.
Example: Use Accept:application/xml to get response data in XML.

The JSON data is always returned inside a JSON API status wrapper, indicating if your API reqest was "success":true, or "success":false, or "error":"error message here".

The actual data you desire, will be in the json element:   "data":{}  

Or if you requested a list of objects, where no ID was given, then you would get an array object  "data":{[.... ]}  

Some end points include plural named options. In general, if you POST, or GET using an ID, you will get a single JSON data object back, otherwise, it will be an array. Sometimes there is a helper element to tell you the "dataType"