Link Search Menu Expand Document
Early Access
Bugs expected

Quickstart


NOTE: The Early Access June release only contains a Docker image. The installer, as described here, is subject to a later code drop. Download 12.0.1-EarlyAccess Beta1 .


What’s New

Here’s what’s new in 12.0.1-EarlyAccess Beta1

  • Installer jar file
  • OData is read and write operations compatible
  • Dependencies updated to the latest
  • At startup we no longer use the DXL to bootstrap the database, hence making the process more stable
  • New Domino server add-in task created for KEEP
  • More API documentation

Let’s get started

To get up and running quickly, you will need to:

  • Install KEEP on a Notes client or a Domino server.
  • Pick a database you want to work with (you could use demo.nsf).
  • Use the KEEP API to enable the database for REST access:
    • Pick the forms and fields to expose.
    • Pick the views you want to be REST accessible.
    • (Optional) pick the agents.
  • Try out the API.

You can use the built-in Swagger API, curl, or the KEEP Admin UI. To help you, use one of the following tutorials. We have a curl based keep shell script for you to play with.

Tutorials

OpenAPI

The Postman collection has sample interactions with the local sample Demo.nsf, go check it out

Endpoints

Ensure your endpoints are secure. Bring up a browser and verify that you can hit these endpoints:

Endpoints Ports Details Webpages
KEEP API Home Page 8880 Start page StartPage
Live KEEP API 8880 Interact live with the API OpenAPI
Admin UI 8880 Login with an admin user. LocalDomainAdmin member Admin Login
Server info (Admin API) 8889 Access to the log and runtime info Server Info
Prometheus Metrics 8890 Performance info in Prometheus format. Protected with basic authentication (metrics/metrics)  
Authorization 8880 This endpoint, [POST] http/s://${HOST}:8880/api/v1/auth, is the default end point to exchange Domino web credentials for a JWT token. For example, use the token in Postman request headers as a Bearer authentication header.  

What’s next?

Based on your interest, start by exploring the following sections of this documentation: