HCL Domino REST API Quickstart Guide
Introduction
The HCL Domino REST API provides a secure and modern way for developers to access Domino servers and databases through a RESTful interface. With this API, you can use your preferred programming language to extend and modernize existing Domino applications.
Step 1: Download the Domino REST API
Get the latest installer or Docker image from the Domino REST API project home.
Step 2: Install and Run the Domino REST API
Follow the Quickstart installation guide to install and start the REST API on your Domino server or Notes client. After installation, complete the necessary post-installation steps to ensure proper operation.
Step 3: Familiarize Yourself with Domino REST API Tools
- Admin UI: Use the web interface to manage API configurations.
- Postman and curl: For testing and debugging API requests.
- Swagger UI: Provides interactive API documentation, allowing you to explore available endpoints.
Step 4: Configure Your First Database
- Choose a Database: Select an existing Domino database or use a sample database like
demo.nsf. - Create a Schema: Through the Admin UI, define the data structure you want to expose via the REST API — including forms, views, and fields. Schemas are a REST API concept managed by the Admin UI or REST API management calls; the underlying NSF forms and views are still designed in HCL Domino Designer.
- Create a Scope: Through the Admin UI, create a scope that serves as an externally visible alias for your database.
Step 5: Test the API
Use one of the following methods to test your API:
- Swagger UI: Interactively explore and test endpoints in your browser.
- Postman: Send API requests and view responses.
- curl: Use the command-line tool to send requests.
Further Learning
For a complete tutorial covering configuration, authentication, and advanced database operations, see the Domino REST API walkthrough.