Connecting to Your PMS (Setup Step 1) BETA
BETA
The setup wizard guides you through connecting your PMS and configuring how resident data is synchronized. The wizard consists of six steps: Connect, Units, Access, Residents, Settings, and Review (the final step page is titled “Finish import”).
The first step in PMS Integration setup is connecting Zentra to your Property Management System using API credentials. This section covers entering credentials, validating the connection, and troubleshooting common errors.
Procedure
- Navigate toSettingsby clicking the gear icon in the lower left of the screen.
- Click thePMS Integrationstab.
- ClickConnecton the RealPage or Yardi integration card, matching your PMS provider.
- If you clickedConnecton the RealPage integration card, enter your credentials:
- PMC ID– Your Property Management Company identifier
- Site ID– Your specific property identifier
- If you clickedConnecton the Yardi integration card, enter your credentials:
- Property ID– Your Yardi property identifier
- Username– Your Yardi interface username
- Password– Your Yardi interface password
- URL– Your Yardi Voyager URL. Click the help icon for the expected format, for examplehttps://www.yardipcv.com/e35ce116d27f
- Server Name– Your Yardi database server name (always the same value as Database)
- Database– Your Yardi database name
- ClickConnect.
The system validates the connection to your PMS. This may take a few seconds.
If Validation Succeeds
A “Connected” message appears and the wizard automatically proceeds to Unit Matching.
If Validation Fails
An error message displays the specific issue. Common errors include:
Error | Cause | Solution |
|---|---|---|
Failed to connect | Incorrect PMC ID or Site ID (RealPage) or incorrect credentials (Yardi) | Verify credentials in your PMS portal |
Property not found | Site ID or Property ID does not exist | Check the ID matches your property |
Connection timeout | Network issue | Check internet connection and retry |
Access denied | Integration not activated | Activate integration in RealPage Developer site (RealPage) or verify interface user privileges in Voyager (Yardi) |
Your API credentials are stored securely and encrypted. Only users with the TenantSettingsModify permission can view or modify these credentials.
RealPage-Specific Notes
For RealPage connections:
- Credentials are obtained through the RealPage Exchange marketplace
- You must subscribe to “Gatewise incorporated” and activate the integration
- The API returns the exact error from RealPage, helping identify the issue
Yardi-Specific Notes
For Yardi connections:
- Credentials are configured in Yardi Voyager under theGatewise Community Accessvendor. See Prerequisites and Requirements for the full Voyager setup steps.
- Yardi requires six credential fields per property because each Yardi connection uses per-property, per-tenant credentials
- The API returns the exact error from Yardi, helping identify the issue
After Connection
Once connected, the system retrieves your unit list from the PMS. This data is used in the next step to match units to Zentra Devices.