Query SAP Business One DI Data from Node.js

Ready to get started?

Learn more or sign up for a free trial:

CData API Server

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 SAP Business One DI data from Node.js.

The CData API Server, when paired with the ADO.NET Provider for SAP Business One DI, exposes SAP Business One DI 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 SAP Business One DI data in Node.js.

Set Up the API Server

Follow the steps below to begin producing secure SAP Business One DI OData services:


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 SAP Business One DI

After you deploy the API Server and the ADO.NET Provider for SAP Business One DI, provide authentication values and other connection properties needed to connect to SAP Business One DI by clicking Settings -> Connections and adding a new connection in the API Server administration console.

To connect to SAP Business One DI data, specify the following connection properties:

  • DBServerType: The type of server being connected to.
  • Server: The name or IP address of the Business One DI server to connect to.
  • CompanyDB: The company to connect to.
  • User: The username used when connecting to the LicenseServer.
  • Password: The password used when connecting to the LicenseServer.
  • LicenseServer (optional): Set this if your License Server is different from the Server.
  • UseTrusted (optional): Set to TRUE to connect using Windows credentials.

You can then choose the SAP Business One DI 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 SAP Business One DI 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 OACT data. The example URL below applies a simple filter that searches for records with a value of account_name in the AcctName column.

var http = require('http'); http.get({ protocol: "http:", hostname: "MyServer.com", port: MyPort, path: "/api.rsc/OACT?$filter=" + encodeURIComponent("AcctName eq 'account_name'"), 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); });