About APIs

The API (Application Programming Interface) defines how software engineers access the capabilities of software like the framework. Workbench is a Niagara API. Using it you create and edit the control logic for your job site.

Many features found in the framework are exposed through a set of Java APIs. In the Java world, APIs are grouped together into packages, which are scoped using DNS domain names. Software developed through the Java Community Process is usually scoped by packages starting with “java” or “javax.” It is important to understand the two types of APIs related to the framework:

javax.baja
The APIs developed for Baja are grouped under javax.baja. These APIs are part of the open Baja specification and may be implemented by vendors other than Tridium. Using these APIs guarantees a measure of vendor neutrality and backward compatibility.
com.tridium
Software, which is proprietary and outside of the Baja specification is grouped under the com.tridium packages. The com.tridium packages contain code specific to how the framework implements the Baja APIs. The com.tridium code may or may not be documented. If com.tridium APIs are publicly documented then the developers encourage other developers to use them, but do not guarantee backward compatibility. Undocumented com.tridium APIs should never be used by developers.

NOTE: Some APIs have been developed under javax.baja even though they are not currently part of the Baja specification. These APIs may eventually be published through Baja, but are currently in a development stage.

About APIs

Related Links