An Industrial IOT Platform

Open-Plant Web APIs

Introduction to Open-Plant Web APIs

Open your Plant to the high tech IT world via Web APIs

RestFul Web Services is the de facto standard for technologies to communicate in the IT World. The industrial world however, lags behind and still uses archaic communication protocols. These protocol are not only old but have many limitations. Most importantly, it is alien to the IT world.

World's fastest and easiest way to create Industrial Web APIs

Before Open-Plant, creating Web APIs is a tedious process. From the infrastructure setup, coding, testing, implementing security and documentation, Web APIs require a dedicated team on its own. With Open-Plant, this process is a breeze. Not only does Open-Plant has a built it Web API Library, it also has allows the creation of custom dynamic Web APIs using OPSCript.

Create dynamic Web APIs that accepts user input 

Open-Plant provides OPScript, the language for Open-Plant Analytics. OPScript can be used to set up Web APIs that accept any user input. For example, you can create an OPScript that calculates the average value of a device (identified by a Tag Id) over a month. This script can be programmed to accept 'TagId' as an input allowing the same script to run on different tags. All this via Web APIs, making it a versatile component for developing Industrial Applications.

Getting Started

Launch Open-Plant Web API from the Open-Plant Client

Open-Plant Web APIs can be configured from the Open-Plant Client. Select 'Web API' from the main screen.
This brings the Web API configuration section as shown below. The section includes a log of all Web API calls made to the system. The default port for all Web API calls are 33170 for Secure HTTP (HTTPS) and 33171 for HTTP.

The secure HTTPS provides a standard SSL encryption for data communication. The certificate is self-signed. To use an externally signed certificate you  can perform a reverse proxy on the HTTP port. See this guide on how to do so.

Let's create a simple Web API Request

After installing Open-Plant, open this link => JS test page (plunkr) 

The link opens a plunkr page which allows one to run web api calls via javascript locally from your machine:

Change the "Username:Password" section of the code to your Open-Plant login username and password (which you set during installation) then hit preview button. The following output should appear in the preview section. This is a JSON object of the 'server info' request from your locally installed Open-Plant Server.

Congratulations, you have successfully made your first API request!

Next Steps

Want to see our comprehensive API library? Want to make custom APIs? Learn more about OPScript, the language for Open-Plant Analytics. With OPScript you can create custom Web APIs that execute specific functions upon call. Click on the links below!
Open-Plant is a revolutionary Industrial IOT Platform software, used to create and deploy Industrial IT apps/solutions. It is an all-encompassing solution offering both back-end and front-end components i.e. the full stack. From our user's experience, creating and deploying Industrial IT apps became 10x faster and 10x less cost. We serve the mining, energy, oil & gas, construction and manufacturing industry. 

OPEN-PLANT PTY LTD

We are based in 
Perth, Australia

EMAIL

Sales / General Enquiry:

info@open-plant.com