iiRDS Request API Specification
More and more business use cases demand a standardized interface to access data via iiRDS. An API specification is needed to grant system providers and programmers the ability to access content via iiRDS and a common API interface.
Thus, the iiRDS Consortium put the development of the request part out to tender in fall 2023 and awarded the contract at the end of 2023 to Empolis Information Management GmbH, which worked together with ICMS GmbH to develop the principles and a detailed OpenAPI specification in accordance with the specifications from the tender. This project was accompanied by the iiRDS Tools Validation Content working group. You can download and test the Request API Specification that were released for comments in June 2024.
This OpenAPI specification describes the structure of a generic API for querying and retrieving iiRDS RDF resources. Several endpoints are specified which, individually or in combination, cover the most common use cases for querying such resources. For a higher degree of freedom in retrieving iiRDS resources, additional endpoints are specified that can be optionally implemented to enable user-defined queries.
Open the OpenAPI Specification
Download "How to Use the API"
iiRDS Request API Mockup
The iiRDS Request API mockup was released on November 14, 2024. It allows developers to experiment with the iiRDS Request API, providing a simplified starting point for implementing the full specification.
The mockup includes all routes defined by the iiRDS Request API specification and generates sample responses to incoming requests. While these responses are syntactically correct per the iiRDS specification, they represent static data rather than a fully dynamic API implementation. Responses are based on iiRDS sample content and do not vary based on request parameters. However, the API mockup does validate API call parameters for correct syntax and structure.
The iiRDS Request API mockup is implemented as a Node.js project, making it easy to run in any environment with Node.js installed. The mockup code is generated from the OpenAPI 3 definition of the iiRDS Request API. It integrates the Node.js Express library and is designed to run independently as a standalone web server. Additionally, a Dockerfile is provided to simplify running the mock API in a containerized environment.
Download the ZIP folder below and read the README.me for more information.