HCL Domino · REST · Automation · Integration
Domino REST API or API-Engine?
The HCL Domino REST API (DRAPI) and the Domino API-Engine from SL Net-Solutions can both be part of a modern Domino architecture. However, they operate at different levels and address different types of tasks.
Put simply, DRAPI makes Domino data and functionality available to other applications through modern REST interfaces. The API-Engine, by contrast, is a server-side integration and automation platform that enables Domino itself to execute processes, process data and communicate with external systems.
It is therefore not necessarily a question of “DRAPI or API-Engine”. In many architectures, the two approaches can complement each other: DRAPI exposes Domino to external applications, while the API-Engine automates processes within and around Domino.
Two Different Tasks
API Access or
Process Automation
Make Domino available to external applications
DRAPI is particularly well suited when modern applications, web frontends or other systems need controlled access to Domino data and functionality.
- REST-based access to Domino
- Integration with modern web and cloud applications
- Standardized HTTP/JSON communication
- Domino as a backend for external applications
- Clear separation between Domino and client applications
Let Domino execute processes itself
The API-Engine is particularly well suited when data needs to be processed, transformed or synchronized within Domino, or exchanged with external systems.
- Time- and event-driven processing
- Direct processing of NSF data
- REST, HTTP, SQL and file system integration
- MIME, email and RFC822 processing
- Data conversion and transformation
- Automated background processes
Feature Comparison
Which tool is best suited for which task?
The following overview highlights the typical focus of both approaches. It is deliberately not intended as a ranking, but as guidance for different architecture and integration requirements.
| Task | Domino REST API | API-Engine |
|---|---|---|
| Expose Domino data via REST | Core purpose | Possible, but not the primary focus |
| Provide external applications with access to Domino | Very well suited | Possible through custom interfaces |
| Call external REST APIs from Domino | Not the primary use case | Direct part of integration processes |
| Scheduled background processes | Not the primary focus | Core functionality |
| Event-driven processing | Depends on the surrounding application | Designed directly for automation processes |
| Direct NSF and document processing | Through the provided API model | Deep Domino-specific access |
| Selective replication and synchronization | Not its primary focus | Part of the Engine functionality |
| MIME and RFC822 processing | Not a typical focus | Direct processing available |
| SQL, file and external-system integration | Through additional applications or services | Direct integration use case |
| Transform data during processing | Typically handled by the calling application | Directly within the Engine process |
| Integrate LLM or AI services | Through the external application | Directly integrable via REST/HTTP calls |
| Availability / product history | Officially available since Domino 12.0.2 | Product lineage dates back to Notes 3 (LOAPI, c. 1994); API-Engine since Notes/Domino 4.5 (c. 1996), continuously expanded since then |
Architecture
DRAPI and API-Engine can complement each other
A typical architecture does not have to choose just one approach. Modern applications can access Domino through DRAPI, while the API-Engine processes data in the background, communicates with external systems and executes automated processes.
Example: A web application accesses Domino data through DRAPI. At the same time, the API-Engine processes incoming documents, synchronizes data with an SQL system or calls external REST and AI services.
Typical Decisions
When each approach makes sense
New web application with a Domino backend
A modern web or cloud application requires standardized access to the data and functionality of a Domino application.
Automated processing of Domino data
Documents need to be checked, modified, synchronized, exported or transferred to other systems on a regular basis.
Modern frontend and backend automation
An external application uses DRAPI, while the API-Engine handles background processes and integrations in parallel.
Domino communicates with external systems
Domino needs to independently read and process data from REST, SQL, file-based or other external systems.
Migration or synchronization process
Data needs to be transferred selectively between different Domino databases while being transformed or cleaned up during the process.
Step-by-step modernization
Existing Domino applications remain in place while being extended with modern interfaces and automated integration processes.
Practical Example
Automatically evaluate an email in Domino using an AI service
One example illustrates the difference particularly well: an incoming email already exists as a document in a Domino database.
The API-Engine can read the RFC822 headers and MIME content, create a JSON structure from the data, call an external AI service through its REST API, process the JSON response and then write the result directly back to the Domino document.
The main focus here is not exposing a Domino REST interface, but executing a server-side process within the Domino environment. This is a typical API-Engine use case.
Conclusion
Not competitors, but different layers
DRAPI and API-Engine address different layers of a Domino architecture. The key question is therefore not always which tool replaces the other, but which task needs to be solved.
the Domino REST API is the natural choice.
the API-Engine is designed for that role.
In more complex Domino environments, both approaches can be used together: DRAPI as a modern access layer and the API-Engine as the integration and automation layer.
Learn More
Explore the Domino API-Engine in More Detail
The SL Net-Solutions Domino API-Engine provides a server-side platform for automation, integration, data processing and synchronization in HCL Domino environments.
If your use case goes beyond exposing Domino data through REST and involves automated background processing, external APIs, SQL systems, MIME and mail processing, data transformation or selective Domino replication, you can find a more detailed overview on the API-Engine product page.
Learn more about the architecture, capabilities and typical use cases of the SL Net-Solutions API-Engine for HCL Domino.
Explore practical articles about HCL Domino development, integration, APIs, MIME, REST, automation and other technical topics.