API Implementation Roadmap

Step 1

Review our API documentation to verify the endpoints available are compatible with your connection goals. At this time, Availability Exchange is designed to provide rates and availability, as well as allow reservations to be created. This API is not designed to share existing reservation information with partners.

Step 2

Review the API agreement and request access to the API. By requesting access, you are agreeing 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.

Step 3

Create your implementation plan and schedule an initial meeting with your development contact. Be prepared to discuss:

How will hosts receive payment for the channel reservations?
Does your channel charge a host commission fee?
What is the user experience you're envisioning? This may be just a quick overview of the user experience, including how the hosts will be set up on your site as well as the guest experience.
Target go-live date
We will cover the marketing material requirements and provide templates to fill the information in.

Please note you are required to have a complete implementation prior to moving on to the beta stage. This includes the getting started, ARI, and Reservations sections of the API documentation.

Step 4

Develop & Implement the API. You will have access to your development contact for any questions during this process. Prior to reaching out please see our Frequently Asked Questions.

You will be given access to 3-5 test properties when you are given credentials to access the API. 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)

If there are specific scenarios you need configured to test during implementation, please reach out to your technical contact to arrange the setup.

Step 5

Certification is required to begin beta testing the connection with live properties. 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.

No later than the date of requesting certification, you must provide your logo and marketing content to ResNexus to create a marketing page as well as a channel info page. The template for this information will have been provided during the initial kickoff meeting.

Step 6

Perform live beta testing. The OTA partner will need to identify a minimum of 3 and up to 15 properties to suggest as beta test properties. You should have reached out to these properties and confirmed their interest in beta testing, while making clear the connection is in progress and there may be issues along the way. ResNexus will reach out to the properties identified by the OTA to ensure the properties are a good fit for the beta process. 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 7

Official Launch and 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.