Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

AbanteCart Storefront API is included in core code distribution starting version 1.0.0.
API is RESTful based with on 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 AbanteCart.  
API build to provide same features as a regular AbanteCart storefront and offer remote or mobile platforms to access shopping cart and perform light weight lightweight eCommerce requests.  
API includes the product (catalog) and customer side support. These includes include browsing categories, products, attributes as well as create a new customer account, loginlog in, add to cart and place orders.  
AbanteCart 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  



By default API is disabled. To enable the API, you need to locate admin settings > system section and enable APISystem → Settings → API  section. If you want to restrict public access with the secret key you can save it in settings. This key will need to be provided with every API request.

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 a list of IPs (comma separated) that will be allowed to access admin API. Other IPs will be blocked.

Tasks API Key: This is a secret key to allow AbanteCart to run scheduled processes from the browser with /task.php file. If not set, tasks will not run via browser.

Info

Tasks API Key is not required for running tasks command line.