Skip to content

Domino REST API walkthrough

Overview

The walkthrough guides you step-by-step on using and configuring the Domino REST API using:

  • Command line
  • Postman
  • Domino REST API Admin UI
  • code examples

Objective

  • Understand how to use the Domino REST API via different interfaces.
  • Learn the configuration of Domino REST API.
  • Gain hands-on experience through code exercises.

Before you begin

Before starting, make sure that you meet the listed prerequisites and skills requirement.

Prerequisites

Make sure you have the following setup:

  • A running Domino server with the Domino REST API installed. This can be:
    • On your local machine
    • On a remote server (must have OS access)
    • Inside a virtual machine
    • Inside a Docker container running Domino REST API container image
  • Postman installed for API testing.
  • curl installed for command-line API calls.
  • An IDE, such as Eclipse or Visual Studio Code, is installed for coding exercises.
  • Node.js (LTS version) for JavaScript exercises.
  • Java Development Kit (JDK 8 or higher) for Java exercises.
  • Reliable internet connection.
  • (Optional) Domino Designer if interested in exploring further.

Important

Don't use a production server for this walkthrough as configuration changes will be made. It is recommended to use a temporary local server.

Skills required

  • Basic understanding of Domino.
  • Familiarity with Containers (optional).
  • Basic API concepts.
  • Ability to use the command line, preferably with curl.
  • For coding exercises, knowledge of Java programming, JavaScript, and Node.js.

Next step

Proceed to Lab 0 - Overview.