When a document is published in the document management module, the document administrator can choose to publish an accompanying news message to attract attention to the new or modified document.
Those messages will appear in the “News” panel on each portal which gives access to the related document. In addition, news messages can be posted which are unrelated to documents by news managers. And it possible to manage existing news messages.
It is possible to retrieve the news articles from Zenya, to display them in another system or app. Of course, it is important that users only get news which is relevant to them. Therefore, the retrieved news articles can be limited to the scope of a certain portal. The concepts “portals” and “collections” are explained in this document.
REST API and WCF API allow you to retrieve news articles.
For news related to documents, you can retrieve the news post, and information needed to construct a hyperlink which allows the user to navigate from the news article to the related document.
For news unrelated to documents, you can retrieve the full article.
Only the REST API supports creating a new news article or manage an existing news article.
The REST API for news_articles can be used to accomplish the scenario’s listed below:
- Retrieve news articles
- Add news article
- Change news article
- Add a news article to or from a portal
- Delete news article
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.