As part of the Domino Early Access Program, we are pleased to announce the first beta of the Domino REST APIs (formerly known as “Project Keep”). We heard from our customers that these APIs play an essential role in allowing you to extend your Domino applications. These APIs are on the roadmap for delivery for Domino Complete Collaboration (CCB) or Domino CEO Communications customers on active support along with the Domino “Danube” release coming in the fall of 2022. Note: The REST APIs only work with Domino v12.0.1 and higher (if you haven’t upgraded yet, now’s the time!).
What is it?
The Domino REST APIs allow for pro-code development through secure access to HCL Domino servers and databases, allowing you to use the programming language and framework of your choice — while maintaining the reliability and deployability of your Domino data and applications. They run alongside the server and allow you to — securely and easily — expose your Domino data in the form of standardized Open-API–based methods. Using a browser-based admin UI, application owners can define which data will be made available for view or update on a REST API. The APIs extends the Domino principles of reader/author document access definitions into the world of Internet protocols.
The Domino REST APIs also includes the Swagger UI, an API explorer that allows the visualization and interaction with APIs without having any of the actual implementation logic in place. The APIs are automatically generated from an OpenAPI (formerly Swagger) specification with visual documentation, making it easier to later implement the back-end code.
What’s special about the new Domino REST APIs?
- Secure by default, with fine granular controls per form, field, and user basis
- Implements latest open standards
- HTTP/2-ready, for server-to-server or client-to-server communication
- API-first design with full interactive documentation
- Low barrier to entry, as it runs on a Domino server and/or your Notes client
- Admin UI and Postman samples included
- State-of-the-art JWT access token integrated with your existing IdP infrastructure
What can be accessed via the Domino REST APIs?
You can access content like views, documents, and fields, as well as agents and ACL settings. And, of course, featuring DQL queries to quickly access the data you are looking for.
Built-in declarative security ensures the API will only allow access to fields the caller is authorized to see or update. This can effectively prevent computed fields to be overwritten and limits participants in a workflow to update their fields only.
How is this different than the previous beta program?
The Domino REST APIs are now focused on application-based data. We will not be providing APIs for mail-related data and tasks. In addition, participation in the beta and access to the shipping release will require a Domino Complete Collaboration (CCB) and Domino CEO Communications license.
How to participate
The Domino REST API is now available as a prepacked, ready-to-use Docker container to Domino Complete Collaboration (CCB) and Domino CEO Communications customers on active support. The download is now available in the “HCL Domino” product line category on our License and Download Portal. Please visit the documentation here to learn more and to set up your test environment.
You are invited to join our Domino Early Access program forum here, to provide your valuable feedback and suggestions on the Domino REST API Early Access program.
Please note, the Early Access program will run from now until the Domino REST APIs are shipped with the Domino “Danube” release coming in fall 2022.
Digital Solutions Product Team