API

Introduction
REC has an API which allows you to integrate with 3rd party systems which require access to information in the database. This is the only way we allow da...
Tue, 26 May, 2015 at 10:22 AM
Getting Started
We are basing our API on a REST styled design. API location Each REC domain/site will have the API accessible at the following address: http(s)://{domain}/a...
Tue, 26 May, 2015 at 10:07 AM
General Conventions
Resource Response Formats JSON is our default format. Its our favourite format and expresses the data closest. E.g. /product/1.json → {"name&q...
Tue, 26 May, 2015 at 10:16 AM
Security
The api will run an authorization module when requests hit it. It will decide the level of access, and pass this to the controller init scripts to determine...
Tue, 26 May, 2015 at 10:19 AM
HTTP Status Codes and Error Handling
We will return HTTP 200 status code for all successful GET requests. 204 will be given for successful updating POST/PATCH or DELETE requests when there will...
Tue, 26 May, 2015 at 10:20 AM
API Resources List
API Resources Products GET /products List / filter collection of products (this can be filtered by the “category”, "status" and “q” url p...
Wed, 13 Sep, 2017 at 1:54 PM
Resources: Products
GET /products List / filter a collection of products URL Parameters category Optional Supplying the category id will filter so only products whi...
Tue, 26 May, 2015 at 10:20 AM
Managing API Accounts in REC
Managing API Accounts in REC API accounts are managed from the API Accounts section in the backend of each REC instance. To ...
Sat, 30 May, 2015 at 11:58 AM
API Push To URL Notifications
API Push To URL Notifications This section is used to send out data based on events in the system. It simply sends out the raw json ob...
Sat, 30 May, 2015 at 11:59 AM
PHP Example
In this example, you will need the url of the site you're using and a public api key which can be generated by an admin of that site. Basic example #1...
Tue, 21 Feb, 2017 at 4:42 PM