Getting Started - API Overview

This page is intended to be a starting point for understanding the API. We recommend reading it before going through other parts of the documentation.

Listing & Pricing integration

The following diagram and the explanations below highlight how you can integrate into the Bookiply Channel API. The diagram only shows the integration for listing data, but the pricing data integration follows the same procedure.

The Bookiply Channel API provides a /v1/updates/listings endpoint that you can call to get information about the listings that were updated since a specific change version. The system ensures that for every listing change, a new strictly incrementing version is generated and provided to you while polling.

The following steps refer to the marked steps in the diagram above.

1. While fetching the listings from the API for the first time, fetch updates from the /v1/updates/listings endpoint. As a response, you will receive a paginated list of listings that you need to fetch.

2. For each object that you received in step #1, call the /v1/listings/{listingId} to fetch the listing information and store it in your system.

3. Fetch listing updates again, this time by providing the cursor parameter that was provided to you in the next field of the previous request. That way, you will only poll new updates. In example #3, there is no new update. In such a case, we recommend waiting some time before fetching it again.

4. After requesting updates again, you receive two new updates. The first update is for a listing you already processed, meaning this listing changed since. The second is a new listing that was published. As shown before, process all listings that you receive and then poll again for changes.

With this simple process, your system can keep listings up to date.