1. API
  2. XML API and SOAP API
  3. API Best Practice Guidelines
  4. Build the API Integration

Build the API Integration

The API provides tools for building a powerful integration. Take some time to plan what you want to do, design your integration and document the process, develop your integration, and test it extensively in a sandbox account. A sandbox account is a safe environment you can use to test new integrations and processes without impacting your production account data. See OpenAir Sandbox.

Step 1: Plan What You Want To Do

Think about what you are trying to achieve in your OpenAir implementation and how the API can increase your ability to do that. Ask and answer the following questions:

  • What are your critical processes? How can the API integration help you streamline them?

  • What are your repetitive tasks? How can the API integration help automate those tasks?

  • What will the API integration be able to do that can help your employees save time?

Step 2: Design Your API Integration

Take time to develop a document that describes your API integration. Your OpenAir Professional Services consultant can expedite this effort and help reduce development time. Gain an understanding of what you are trying to achieve so that key players in your organization can provide valuable feedback before you the development starts.

Step 3: Develop Your Integration

Read the API documentation in its entirety, talk to your OpenAir Professional Services consultant, and learn about the OpenAir data model and how it is used. Links to key information are provided in XML API and SOAP API and Getting Started with the XML API and SOAP API.

  • Develop the API integration with the help of your OpenAir Professional Services consultant. Incorporate labels and terms that will both reduce confusion and enhance the integration you develop.

  • Test the API integration in your sandbox account. It is crucial that you use a non-production environment until you can be sure that the integration runs smoothly without error and does not damage vital production data.