List API Settings

This page can be accessed by going to System > Settings > API

Storefront API status : Enable or Disable store API.

Storefront API Key : Set this key to provide restricted (more secure) access to storefront API. Leave blank no key.

Storefront API Stock Access : Enable if you allow storefront API to check stock availability.

Admin API status : Enable or Disable Admin API.

Admin API Key : Set this key to provide restricted (more secure) access to Admin API.

Admin API Access IPs : Provide list of IPs (comma separated) that will be allowed to access admin API. Other IPs will be blocked.

After you have made your changes, select the save button

Introduction

WebriQshops Storefront API is included in core code distribution starting version 1.0.0. API is RESTful based with JSON as a primary data document format. API supports both HTTP and HTTPS protocols along with extra security if using API key configured in the control panel of WebriQshops.

API build to provide same features as regular WebriQshops storefront and offer remote or mobile platforms to access shopping cart and perform light weight eCommerce requests.

API includes product (catalog) and customer side support. These includes browsing categories, products, attributes as well as create new customer account, login, add to cart and place orders.

WebriQshops API is optimized to perform light and fast responses to the client’s requests.
API rt routes are explicit and start with a/... , example, a/product/product

Enable API:
By default API is disabled. To enable the API, you need to locate Control Panel (admin) settings -> system section and enable API. If you want to restrict public access with secret key you can save it in settings. This key will need to be provided with every API request.