Learn more
 

Ready to get started?

Learn more:

Business b-ridge Connectivity Solutions

In this article

Related articles

Query Business b-ridge 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 Business b-ridge data from Node.js.

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

Set Up the API Server

Follow the steps below to begin producing secure Business b-ridge 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 Business b-ridge

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

When connecting to Business b-ridge, CompanyKey, ProjectKey, and SubscriptionKey are required.

To obtain the SubscriptionKey, follow the steps below:

  • Log in to Business b-ridge API Protal and go to "Profile" in the "Your name" menu.
  • In your subscription section click "Main Key" to retrieve their respective values.

Authenticate to Business b-ridge Account

Set the following connection properties to connect:

  • CompanyKey: Set the Business b-ridge Company Key of the connection destination.
  • ProjectKey: Set the Business b-ridge Project Key of the connection destination.
  • SubscriptionKey: Set the value "Subscription Key".

You can then choose the Business b-ridge 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 Business b-ridge 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 CDATA data. The example URL below applies a simple filter that searches for records with a value of 1 in the ItemTypeId column.

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