JSON API – Introduction
  • 14 Sep 2020
  • 2 Minutes To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

JSON API – Introduction

  • Print
  • Share
  • Dark
    Light

Nimblex 5.4 and above include a JSON API. This feature is intended to allow for integration options without direct EBMS intervention. The JSON API is a mechanism to allow external applications to read and make changes to data within a Nimblex system.

The current version of the API includes everything you need to manage and maintain user and department structures to eliminate the need for redundant maintenance in multiple different systems; functions to create, read, update and delete records, as well as record parent child relationships – allowing synchronisation of data between systems.

To aid in discoverability, any GET APIs will output the result with indentation and with inline hyperlinks for navigation when accessed from a browser.

JSON API Standard

The Nimblex JSON API conforms to JSON API v1 (http://jsonapi.org/format/ ). All requests take the form of a single HTTP request that contains a single JSON object (or is blank for certain request types).

Where possible this API will maintain conformance with JSON API (currently 1.0). This provides a strong framework for managing and accessing entities (Resources) with unique identities, and relationships between them.

The standard does not currently effectively deal with:

  • Reporting / summarizing of data
  • Files or other byte streams

In these cases we have made the decision to implement an API that is not strictly conformant with JSON API. The relevant API functions are marked “Not conformant with JSON API”. Where possible, compatibility is maintained to the extent possible: I.e. using the same container format, HTTP Methods and error codes.

At some future point it is hoped that JSON API will catch up in these areas and we will provide JSON API conformant options. Our intention is to also maintain our existing API functions for compatibility.

Understanding this Documentation

In any case where you see @apiroot , you should substitute the root url of your system install, with the suffix /api/json/1.0/. For example if you instance is at https://ebms.com.au/v4/something, you would use https://ebms.com.au/v4/something/api/json/1.0/.

Versioning

When possible, additions to the API will be strictly additive and not affect existing users of the API. When and if we are forced to implement incompatible follow up versions of the API, the /json/1.0/ urls will be maintained for existing users, and we will move on to /api/json/1.1/ or /api/json/2.0/ depending on the scale of the changes.

Index

Use these links to navigate around this API documentation.

Was This Article Helpful?