Workshop – HCL Domino REST API

Discover the full potential of the HCL Domino REST API in this hands-on workshop. Learn how to deploy modern, secure, and standards-compliant REST interfaces to your Domino databases. The workshop covers concepts such as schemas, scopes, OAuth2-based authorization, and access controls – and demonstrates how to publish and consume Notes data as structured JSON resources. You'll learn how to programmatically integrate Domino applications and extend your own REST endpoints using modern tools like Swagger UI, Postman, and VS Code.

This workshop is aimed at Domino developers, administrators, architects and technical consultants who want to open up their Domino infrastructure for modern web applications, cloud integration or third-party systems.

Introduction and Architecture

• Goals and role of the Domino REST API
• Differentiation from previous Domino integrations
• Architectural overview

Installation and requirements

• System requirements and supported platforms
• Differences between the installer and Docker variants
• Configuration notes: (Ports, activation and commissioning)

Data access via REST

• OpenAPI 3.0 (Swagger) as an interface definition
• Accessing Notes data via JSON
• Working with Notes documents, views, rich text, and attachments

Security and access control

• Authorization with OAuth 2.0 and JWT
• Access via Scopes, Identity Provider and Tokens
• Access protection at the field level via scheme

data modeling

• Schema vs. Form: Modern Representation of Notes Data
• Creating schemas (via AdminUI or file resources)
• Use of field extensions

Tools and practice

• Using Swagger UI, Postman, curl
• Quick start: from installation to the production endpoint
• Troubleshooting, health check, Prometheus monitoring