Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →
Query HCL Domino Data from Node.js
The API Server exposes Web services that allow connectivity to your data. Use the OData endpoint of the CData API Server to execute CRUD queries to HCL Domino data from Node.js.
The CData API Server, when paired with the ADO.NET Provider for HCL Domino, exposes HCL Domino data (or data from any of 200+ other ADO.NET Providers) as an OData endpoint, which can be queried from Node.js using simple HTTP requests. This article shows how to use the API Server to request JSON-formatted HCL Domino data in Node.js.
Set Up the API Server
Follow the steps below to begin producing secure HCL Domino OData services:
Deploy
The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.
The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.
Connect to HCL Domino
After you deploy the API Server and the ADO.NET Provider for HCL Domino, provide authentication values and other connection properties needed to connect to HCL Domino by clicking Settings -> Connections and adding a new connection in the API Server administration console.
Prerequisites
The connector requires the Proton component to be installed. Normally, Proton is distributed as part of the AppDev pack. See the HCL documentation for instructions on acquiring and installing Proton or the AppDev pack.
Once the Proton service is installed and running, you will also need to create a user account and download its Internet certificate. This certificate can be used to set the connector certificate connection properties.
Authenticating to Domino
- Server: The name or IP address of the server running Domino with the Proton service.
- Port: The port number that the Proton service is listening on.
- Database: The name of the database file, including the .nsf extension.
- SSLClientCertType: This must match the format of the certificate file. Typically this will be either PEMKEY_FILE for .pem certificates or PFXFILE for .pfx certificates.
- SSLClientCert: The path to the certificate file.
- SSLServerCert: This can be set to (*) if you trust the server. This is usually the case, but if you want to perform SSL validation, you may provide a certificate or thumbprint instead. See the documentation for SSLServerCert for details.
Additional Server Configuration
The connector supports querying Domino views if any are defined. Before views can be queried by the connector they must be registered with the design catalog.
Please refer to the Catalog Administration section of the AppDev pack documentation for details on how to do this.
You can then choose the HCL Domino entities you want to allow the API Server access to by clicking Settings -> Resources.
Authorize API Server Users
After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; all IP addresses except the local machine are restricted by default. You can authenticate as well as encrypt connections with SSL.
Consume HCL Domino OData Feeds from Node.js
OData feeds are easy to work with in Node.js. You can use the HTTP client in Node.js to request JSON-formatted data from the API Server's OData endpoint. After making the request, you can construct the body of the response and call the JSON.parse() function to parse it into records.
The code below will make an authenticated request for ByName data. The example URL below applies a simple filter that searches for records with a value of Miami in the City column.
var http = require('http');
http.get({
protocol: "http:",
hostname: "MyServer.com",
port: MyPort,
path: "/api.rsc/ByName?$filter=" + encodeURIComponent("City eq 'Miami'"),
auth: 'MyUser:MyAuthtoken'
},
function(res) {
var body = '';
res.on('data', function(chunk) {
body += chunk;
});
res.on('end', function() {
console.log(body);
var jsonData = JSON.parse(body);
});
}).on('error', function(e) {
console.log("Error: ", e);
});
Data Connectors
ETL/ ELT Solutions
Cloud & API Connectivity
OEM & Custom Drivers