THE API PROCESS

CONNECT TO THOUSANDS OF PROPERTIES USING RESNEXUS PROPERTY MANAGEMENT SOFTWARE

How Does the ResNexus Availability Exchange API integration Process Work for OTA Partners?

ResNexus properties are registered with Availability Exchange and can choose to share their property info, availability, rates, etc. with any trusted OTA Partner that has completed the API integration process with Availability Exchange. In addition, ResNexus properties can automatically receive bookings from a OTA Partner via Availability Exchange.

The average Availability Exchange integration timeline is usually 2 months. The first month accounts for the OTA Partner building matching endpoints and the connection being certified by ResNexus. The second month includes live testing by using 3-5 ResNexus properties to Alpha test the connection. Once the connection is deemed stable, the new OTA Partner will show up as an available booking channel to all ResNexus properties. The last phase may include marketing material to announce the new connection between ResNexus and the newly certified OTA Partner.

The Suggested Development Process:

STEP 1:

REVIEW API DOCUMENTATION

We recommend new OTA Partners start by reviewing the API endpoints of Availability Exchange.

API Documentation

STEP 2:

REQUEST ACCESS TO API

You can start developing to the API by requesting access. By requesting access to the API you agree to follow the API Agreement. Once access is approved, you will be provided API credentials and can develop in the sandbox. If you want to provide credit card information when submitting reservations, you should inform your development contact at this step to ensure we have your PCI Attestation of Compliance (AOC) on file before you are certified.

API Agreement

Request Access

STEP 3:

DEVELOP & IMPLEMENT THE API

It is up to the approved API Partner to use their time and resources to build to Availability Exchange. ResNexus will answer any questions not clear in the in the current API documentation. Use the business information to match properties in your systems or as marketing lists for finding mutual customers.

The following business IDs are sandbox properties for use for testing and development, and are accessible after a partner goes live so they can continue development:

887 - Sample Bed and Breakfast #1
3365 - Sample Bed and Breakfast #2
3621 - Sample Bed and Breakfast #3
14983 - Lodging Sample - Cabins and RV Sites
15217 - Sample Campground
15240 - Sample Hotel and Restaurant
16262 - Sample AirBnB - Vacation Rental
16609 - Sample Hotel (Large)

API Documentation

STEP 4:

CERTIFY YOUR API CONNECTION

Once your endpoints are completed and connected to Availability Exchange, we will use the sandbox to test those connections. A ResNexus developer will work with you until your connection is stable. Stable means to have 5 successful calls to each endpoint. Once your connection is stable, request live access. ResNexus will then perform a certification test.

If you haven't already, your authorized representative should formally sign the terms and conditions. Use the "Get Businesses" API endpoint to see all the ResNexus properties that are registered and their property info.

When no errors are detected, you will receive your certification from ResNexus. Once certified, you can start sending reservations immediately for the following two cases: 1) Sending reservations without payment information or 2) You collect the payment. To send credit card information, you must provide a PCI AOC. Partners can use virtual cards or the original card information to send to ResNexus.

If you accept, process, create or transfer cards (including virtual cards) for use with AE Gateway, you need to be PCI Compliant.
Click PCI Compliance below for more information.

Request Live Access

PCI Compliance

STEP 5:

PERFORM 30 DAY BOOKING CHANNEL TESTING

The OTA Partner should identify 3-5 properties willing to alpha test the connection for 30 days. This are usually the properties most requesting the connection between ResNexus and the OTA Partner. The OTA Partner should set contracts and pricing with the properties directly. The OTA Partner should provide their logo to ResNexus.

ResNexus and the OTA Partner will closely monitor the reservation activity of these test properties for 30 days. This provides a polishing period for any small errors that may occur.

STEP 6:

OFFICIAL LAUNCH & MARKETING ANNOUNCEMENT

ResNexus and OTA Partner will work together to market the new partnership to mutual clients and properties. Marketing efforts may include a joint press release, webinar, or industry wide email.

Request Joint Marketing

Availability Exchange Integration Roadmap

Accepting Reservations on Availability Exchange

Properties are ready to accept reservations from new partners immediately
Unit groups are preferred (if configured)

Listed on
Availability Exchange

Properties are listed, but may or may not have provided Availability, Rates, and Inventory (ARI) data for partners to use
ARI data may be available for individual units, but unit groups may not be configured yet
If ARI data is not available, the property must allow sharing that data in ResNexus under Settings > Availability Exchange
To receive reservations, properties must enable Direct Connects in ResNexus and add Availability Exchange as a channel

Unlisted on
Availability Exchange

ResNexus properties that have opted out of Availability Exchange are not listed. Properties can change this setting in ResNexus under Settings > Availability Exchange Accepting Reservations

Frequently Asked Questions

What is the booking process?

The bookings process includes two items. 1) Call the Quote endpoint to confirm rates and availability. 2) Call the CreateReservation to create the reservation.

Can the OTA Partner set the booking rate?

Yes. We want OTA Partners to be able to specify the rates, offer promotions, or make rate adjustments for different classes of guest (eg. premium members). OTA Partners should only change rates within the bounds of contractual limits they have set with individual properties.

Do OTA Partners use units or unit groups?

OTA Partners decide! If a property has not yet set up their property to receive reservations from Availability Exchange OTA Partners, they likely have not set up their unit groups either. OTA Partners can still connect to the property and start accessing their information by individual units, as that is automatically available. Once the property has unit groups set up, you can switch your API queries to using unit groups instead. Some properties have unique units though, so you'll want to support both versions.

Can Availability Exchange tell us when availability and rates change?

We're working on this. We designed the endpoints to minimize the need for OTA Partner caching, but may expose timestamps to help with cache updates.

If OTA Partners are caching data, we recommend querying the next 30-90 days of availability and rates at least once per day as that is the most common lead time for most bookings. Otherwise, we designed the endpoints for partners to make queries on the fly. The quote and create reservation endpoints will always rely on the most up to date information.

Can OTA Partners make bookings in the sandbox?

Absolutely. All the properties in the sandbox are there for partners to test the reservation flow.

After leaving the sandbox, OTA Partners can continue making queries for sandbox properties, including making reservations. The only change is that the sandbox properties will no longer be listed under the GetBusinesses endpoint (unless a specific property is queried). We recommend saving the ID for at least one sample property so that your integration can continue to test reservation endpoints.

What types of reservation modifications can OTA Partners make?

Shorten or extend a stay, change units, or reschedule a stay. To make these modifications, simply query the ModifyReservation endpoint with the desired state of the reservation.