Card file API
The Card file module allows organizations to keep track of devices, buildings, suppliers and so on. Its primary advantage above keeping such registrations in an Excel or Access file, is that each card can easily be referenced from other Zenya modules. For example: when reporting an incident, you can easily select the card for the device to which the incident is related, instead of having to enter that data manually. Afterwards, you can go to the card and easily view all related cases, documents, question lists for that card.
The API for this module covers automated retrieval, creation and manipulation of cards in the various card files which have been defined by the customer.
It also allows to perform limited application management tasks.
Searching for – and retrieving lists of – cards is also possible via API’s which operate on portals or collections. The purpose of the portals and collections is discussed further on in this document. The purpose of the portals and collections is discussed further in this document.
The REST API can be used to accomplish the scenario’s listed below:
- Retrieval of cards
- Creating cards
- Manipulating cards
General API usage information
Overview of important information for consumers of the Zenya REST API, with topics like versioning, verbs, status codes, authentication and error handling.
Overview of changes and announced deprecations regarding the Zenya REST API.
Our code samples on GitHub show you how to get started with the Zenya REST API.
A detailed reference for this API is provided in Swagger format.
Please note that the Swagger reference is also present in each customer’s Zenya tenant. You can find it by adding /api to the URL of the customer’s Zenya tenant. For example: https://organisation.zenya.work/api
In order to interact with the Swagger reference, you need to access the Swagger in the customer’s Zenya, and you need valid credentials for the customer’s Zenya.