iProva has support for federated search; it allows 3rd party intranet or portal solutions to forward a search query to iProva and receive the search results, which can then be displayed to the end user by the 3rd party solution together with the search results from that system and/or other federated systems.Search results can include (depending on the licensed modules):
- Process flowcharts
- Question list
- Reports (management information)
- Links to web pages/network locations
iProva itself protects the end user from information overload by directing him to a start portal which gives access to information relevant for that user. It is important that the same principles are kept in mind when integrating iProva in a 3rd party intranet or portal solution. Therefore, search queries can be and should be limited to the scope of a certain portal or to an even smaller scope: collections. The concepts “portals” and “collections” are explained in this document.
For 3rd party systems which cannot support federated search or prefer to include all content in their own search index, it is also possible to crawl the content of iProva instead of using the federated search API.
REST API and WCF API are available for federated search. They support searching in specific scopes. Search results are automatically security trimmed (only results which are accessible to the user will be included). For each result, an URL is returned which can be used to redirect the user to the iProva screen in which the actual content will be shown.
The REST API and WCF API support content crawling.
The WCF API supports refining search results (faceted search).
The REST API for content_items can be used to accomplish the scenario’s listed below:
- Perform a keyword search action and retrieve a paged list of search results.
- Crawl through all items for a specified user for a 3rd party index.
General API usage information
Overview of important information for consumers of the iProva REST API, with topics like versioning, verbs, status codes, authentication and error handling.
Overview of changes and announced deprecations regarding the iProva REST API.
Our code samples on GitHub show you how to get started with the iProva 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 iProva tenant. You can find it by adding /api to the URL of the customer’s iProva tenant. For example: https://organisation.iprova.nl/api
In order to interact with the Swagger reference, you need to access the Swagger in the customer’s iProva, and you need valid credentials for the customer’s iProva.