Note
This article describes the legacy API of Xentral. We recommend using the latest generation of Xentral API instead.
For a full documentation of the latest generation of Xentral API, refer to developer.xentral.com.
Two APIs currently exist in xentral:
-
REST-API
-
Standard-API
You can find more in-depth information here.
The documentation for the REST API can be found in the xentral installation, matching the installed version, at www/api/docs.html. Here, the following will be explained:
-
how to create an API account
-
how to make requests to API resources, and
-
which API endpoints exist
The API documentation is shipped with xentral and can be accessed in any xentral instance at instancename/www/api/docs.html in the browser. However, the /www/ is often not needed. Alternatively, the API documentation, organized by version, can also be found online: https://update.xentral.biz/apidoc/docs211.html
As a rule, the version can be specified in the path name. For example, version 21.1 can be found in the path docs211.html.
In the documentation of the Rest API, there is information about
-
the debug mode
-
the error codes
-
web server configuration for Apache and Nginx
-
accessing test databases (also test or MultiDB systems, from version 20.1)
Documentation and practical examples for the xentral standard API can be found online.
Note
When in doubt, the REST API is preferable for integration. The functions of the standard API will also be available in the REST API in the future.
Information, definitions and available functions can be found in the xentral documentation Standard-API.
Note
From version 22.1.x the hash authentication is no longer supported therefore you have to switch to DIGEST Auth via the REST API.