Introduction

Zengine provides a RESTful API which maps virtually every resource in the platform to a list of URIs. These URIs can be retrieved and manipulated with HTTP verbs.

Audience

The API is made available for a wide variety of use cases, including commercial applications. Some possibilities include:

  • JavaScript plugins
  • Mobile clients
  • Integration with third party web & mobile applications
  • Bulk fetching & processing of private data
  • … and more

The documentation herein is provided as a reference guide for third party developers who wish to learn more about the API’s conventions and resources.

Restrictions

The Zengine API is in beta, which means it is still rapidly maturing. While we do not expect the conventions or resources to change in a way that prove destructive to third party integrations, we cannot makes any promises.

Rate limiting in version 1 of the API is primarily considered on a per-user basis — or more accurately described, per access token. Each access token is allowed 250 queries per 5 minute window. Additionally, these limits apply on a per-plugin basis. So one user can also make 250 requests per 5 minutes per plugin.

We expect you to be kind - only make requests which are necessary, use caching techniques whenever possible, and use the API in a way that does not have a negative impact on Zengine’s business or infrastructure. We, of course, reserve the right to suspend API access to anybody acting against the spirit of these restrictions.

The API is currently provided free of charge. We expect for this to remain true indefinitely, as our intention is to charge the end users of Zengine, not the developers who add value. But again, we reserve the right to reverse this decision in the future.

These restrictions will become more formally defined over time, but the purpose and intended audience of the API is a constant.