browse

5 Minute Read

The Need for Interoperability

With various OEMs and Integrators present in a Building space, having all BIS/BMS systems to be integrated under common dashboards or grouped together for monitoring is not a easy task, adding to this complexity each OEM/Integrator has their own format of data and own interpretation that is maintained, having  a standard simple way to extract only the data needed from one system and integrate this data into another OEM/Integrator's system will allow for various functioning and operation. It also allows various BMS/BIS systems to co-exist in a single building paving way to interoperability.

75F API

75F Renatus APIs allows the external partners and developers to integrate with the 75F system data. 

API is a simple REST mechanism to exchange Haystack-tagged data over HTTP or HTTPS. 

The Haystack API allows software applications and devices to communicate using an open protocol that is designed around exchanging data by querying based on Haystack tags. (For those of you who are developers) 

API External Exposure

75F APIs exposed to external use is extremely Simple and Haystack driven 

75F REST-like JSON API is as simple as possible and it has ensured that the API endpoints are in the same format as the haystack server used by the Haystack Community. 

OEMs/Manufacturers use the Haystack topology and taxonomy to generate and store data a format that is easy for all BMS community of users to read and understand easily.  

Inorder for other haystack users to connect their applications with 75F generated data for further integration with device data, 75F exposed API service endpoints needs to be programmatically used with haystack operations like read, pointwrite, filters and many more.  

This enables a wide variety of functionality, features, and a vibrant community for data exchange for interconnecting things. 

When two systems speak Haystack, integrators can connect over APIs easily for them to “just work” seamlessly for providing  single pane of dashboards, control from their application and trending from their application using 75F data.  

Note : It is the responsibility of the API consumer to refer Haystack entities and points by referring the Site explorer tool using the credentials created for developer in Facilisight Portal. 

Advantages

  • Very Secure.
  • An open API is based on modern web standards and uses OAuth 2.0.
  • Extremely Simple and Haystack driven.
  • REST-like JSON API, as simple as possible 
  • Can be used to built any internal 75F app
  • Can do everything we(75F) can do. 
  • Very well Documented and up to date
  • APIs are live and Active
  • Over 16 million API processed in a month. 

The 75F solution easily integrate into any 3rd party Web service via our Haystack compliant application programming interface.  

  • This is useful where partners like utilities, REITs ,ESCOs would like  
    • real time data feeds  
    • machine learning data for their learning models or compliance tools.  
  • This would also be applicable for customers who might integrate 75F into their employee engagement apps or reporting dashboards. 
  • This also helps us to further deepen our analytics based on Customer needs . 

Note: It is the responsibility of the API consumer to ensure that the Haystack entities and objects is properly handled by the callers  implementation. 

 

75F External API Access 

Below is a illustration about the 75F external API access.

blobid0.png

75F APIs will act as the entry point to all server architectures, which forms basis of inter-component communication across systems. 

A very well designed, implemented, and versioned APIs will ensure maintenance of current, large scale software platforms becomes easy, without a very large technical support team. This detailed documentation for the 75F platform's APIs is to  ensure that.  

  • The platform integrations are less prone to defects.
  • Integrations are not difficult but made easy so that both internal and external developers are not frustrated. 
  • To ensure that external stakeholders do not misunderstand  
  • To ensure that external stakeholders do not underestimate the value of this integration platform. 

75F External API Capabilities 

75F API (Application Programming Interface) end points are interfaces that provide a external or internal program with a connection point to interact with 75F system, in order to retrieve and/or change the haystack data or any other equipment data within it. 75F “web APIs”; that is, APIs provided over the HTTPS protocol for haystack based data made available for integrators. 

The APIs will enable integration developers to 

  • Retrieve site level Information.
  • Retrieve all zones data for a  site.
  • Retrieve all points generated by any equip in a  Site. 
  • Retrieve all entities have a set of tags in a  Site 
  • Retrieve all entities filtered by tags in a  Site 
  • Retrieve all vacations and schedules  in a  Site 
  • Retrieve data of a particular point if ID of the point is known 
  • Retrieve current value  of a historized or writable point if ID of the point is known 
  • Poll a range of data for a date range for any historized point in the Site 
  • Write value to a point which is writable into the system if ID of the point is known

blobid1.png 

 

The 75F API provides an http-based interface for control and access to the 75F Platform data. Integrators will be allowed to read, update and poll information about their Site data. 75F aims to be backward compatible with previous versions of the API and to protect implementations from breaking when new features or changes are implemented. The API also strives to be self-documenting, easy to understand and use. 

JSON Notation 

JSON notation is used for serialization of request/response objects sent to and from the 75F API. JSON is a lightweight data-interchange format. It is easy for humans to read and write and machines to parse and generate. JSON has become a common, open format, used widely in all manner of web based applications. There are JSON parsers available for almost all development languages. 

More information in JSON may be found at http://json.org 

Previous
Next

Comments

0 comments

Please sign in to leave a comment.

Was this article helpful?

0 out of 0 found this helpful
Powered by Zendesk