Link Search Menu Expand Document
Early Access
Bugs expected

Connecting your application to KEEP

Any programming language is able to connect to a REST API. Depending on your approach, there are some particularities to observe.

We distinguish between client and server based applications. Client based applications can access databases that have been marked for Open Access, while server based applications can provide an application id and application secret to get a different level of access.

Browser based applications

Browser based applications (ReactJS, Angular, Vue, VanillaJS) can be hosted on a different server than the URL of the KEEP API. To enable access to KEEP (besides the user’s credential), CORS need to be configured to allow access from the server providing the static files to KEEP. This is configured in the security.json in the CORS section. You need to add your domain and set it to true. To simplify corporate deployment, we check domain endings only. Which means that acme.com covers www.acme.com, hr.acme.com or even one.two.three.acme.com.

The default entry in security.json is like this:

"CORS": {
        "localhost": true,
        "hcl.com": true,
        ".local": true
    }

Let’s say you want to disable the preset and enable acme.com, you create a security.json with this content:

{
  "CORS": {
    "localhost": false,
    "hcl.com": false,
    ".local": false,
    "acme.com": true
  }
}

Hosting your static application on KEEP

Frameworks like Angular, ReactJS, Swelte etc. usually generate a build directory with a set of static files.

You can copy that directory to keepweb.d in your Domino data directory and KEEP will serve them on the /keepweb/ URL path. This eliminates the need for CORS configuration

Check the details in Security Configuration.

Server based applications

In the Admin Client (or the Admin API), we can define an “application” which consists of:

  • AppID, which is the Application ID
  • AppSecret, which is the secret defined for the application
  • Databases, which is the list of KEEP database that the application wants to access

When the application presents AppID and AppSecret in the header of a request, it can access the databases, even when they are not defined as “Open Access”. Thus, an application server can have more access than a browser application.

The point to note here is that there is “no security bypass”. The access to the databases is still governed by their ACL. So, when a user accesses databases via the app but has no access privileges, access to the database will be denied.

Desktop applications

These are applications designed using Java or .NET, Electron or shell scripts with curl.

Since desktop applications can’t keep secrets, we treat them like browser applications. They can only access Domino databases that are flagged for “Open Access”. You don’t need to worry about CORS setup, unless you are running a local http server. This is why localhost is in the default CORS permission list.