Getting Started

Welcome to the Zeald developer program. This area provides tools that allow approved developers to build applations that tightly integration to a ZEST website.

We provide three main APIs:

  • Data API - an extended REST API allowing you to efficiently pull & update data resources for a ZEST webste.
  • Files API - a WebDAV server allowing you direct access to the files and images associated with a ZEST site.
  • Store API (beta) - a headless ecommerce API allowing you to interact with the ecommerce systems provided by ZEST, browsing products, creating a cart, checking out.

In addition to this your app can subscribe to event notifications using ZESTs webhook event notification system.

First steps

To get underway with development of your integration app:

  1. Ensure you have read and agree to the developer program code of conduct.
  2. Contact developer support so we can provide you a test site to develop on.
  3. Learn how to get connected - creating an API application key for the website you are connecting to.
  4. Use the developer API's as documented on this site.
  5. If you have problems, we offer only email support, within defined parameters.
  6. If you feel your application may be of interest to other users of ZEST, or you would like to explore using ZEST more with your customers drop us a line.

Authentication

ZESTs primary APIs offer two methods for authenticating requests:

Read the authentication guide for more details.

SDK

We offer a comprehensive fluent PHP SDK for interacting with the Data and Store APIs. Further information is available here.