API Overview

OpenAir API provides programmatic access to your OpenAir account data and business processes without using the OpenAir UI. You can use the OpenAir API to perform operations and integrate OpenAir with other applications.

OpenAir API includes the following component APIs:

• XML API – The XML API interfaces with the data layer in OpenAir and provides the most comprehensive programmatic access to your OpenAir data.

• SOAP API – The SOAP API uses SOAP-based web services, and serves as a wrapper around the XML API, providing the same or similar functionality.

• REST API – The REST API interfaces with the business layer in OpenAir. This ensures that business rules configured for your company's OpenAir account are applied when an integration application interacts with your OpenAir data through the REST API. However, the REST API is limited in scope compared to the XML API and SOAP API and currently provides access to selected object types only. For more information about

For more information about the XML API or SOAP API, see XML API and SOAP API.

For more information about the REST API, see REST API.

The following help topics describe features that can be used with all three component APIs:

• OAuth 2.0 Authorization

• API Limits

• Web Services Logs

Note:

The functionality described in this guide is available if the API Access feature is enabled for your account. API Access is a licensed add-on. To enable this feature, contact your OpenAir account manager.

OpenAir Mobile and other add-on services provided by OpenAir use the API to access your OpenAir data. You do not need API Access to use OpenAir Mobile, OpenAir Exchange Integration Manager, OpenAir Integration Manager, OpenAir Projects Connector or OpenAir OffLine.