Skip to content
Get Support
  • There are no suggestions because the search field is empty.

Yardi Integration: Setting up the Integration

This article covers how to configure your Yardi system and what data points are needed to set up the integration with OneApp.

Step 1 – Configuring the Vendor Options for OneApp Guarantee

Menu Path: Basic iData Menu > Interfaces > Configuration > Review Interface Vendors > Interface Configuration
  1. Confirm the vendor name appears in Voyager under ILS Guest Card. If the vendor is not present, contact Yardi Technical Support to load the vendor package.
  2. Select OneApp Guarantee
  3. Select the options desired on the vendor configuration screen. These options are based on client preferences and vendor requirements. The available options vary depending on the interface type.
  4. Save the configuration options.

Step 2 – Configure the Property or Property List

Menu Path for a Single Property: Setup > Property > Find Property > [property code] > Submit.
  1. Click on the Functions drop down menu. Click on Interface Configuration.
  2. Click the appropriate Interface type under Interface Configuration (i.e. ILS Guest Card)
  3. Highlight OneApp Guarantee under Available Agencies. Click Select and Save.
Menu Path for a Property List: Interfaces > Configuration > Bulk Property Configuration.
  1. Enter property list code
  2. Select Interface Type from drop down.
  3. Select Configure.
  4. Highlight OneApp Guarantee from the list of Available Agencies and click Save.

Step 3 – Configure the Interface User

Menu Path: System Administration >Security > Add User
  1. Create a new interface user and link to a security group for the specific Interface Type. The security group should have Read or Read/Write access for appropriate web services permission(s)

(e.g.) Interfaces: Web Service – ILS Guest Card

Interfaces: Web Service – Common Data

  1. Enter the property code or property list code in the property field to allow interface user access to properties configured for OneApp Guarantee.
  2. Click on the Privileges tab and Select “Interface User”. This will give users access through the web services, but not the Voyager front end.
  3. Click Save.

Mutual Clients should enter a case in the Yardi Client Central if assistance is needed with any Step in this document.

Step 4 – Provide Access Information to OneApp Guarantee

  1. Voyager URL (vendor will append the appropriate web services endpoint)
  2. Interface username and password
  3. Database Name
  4. Server Name (will always be the same as Database Name)
  5. Names and Yardi Property IDs for any properties where the integration should be enabled

Clients should always notify the third-party vendor of any changes to Voyager URL, database server, or database name.