Welcome
The Redeam Channel and Partner APIs provide a flexible solution for connecting tours & activities suppliers with Redeam's ecosystem of resellers and online travel agencies.
If you are a reseller or OTA looking to sell tours & attractions through Redeam, please see our Booking API documentation.
If you wish to become a Redeam Channel API partner and integrate to the Channel API, you must first complete the following Technical Questionnaire . Our team will get in contact with you once your application has been reviewed. NOTE: Development to the Redeam Channel API can only commence once your application has been 'approved', and any applicable agreements are signed.
About Redeam
Redeam is a leading travel technology company solving a multi-billion dollar problem in travel: Paper Vouchers.
Integration Process
The integration process starts with one or more technical design and review meetings. During these meetings, our team will work with you to define and map your unique system requirements to the Redeam API. Once your integration is complete, a Redeam engineer will certify the integration by running a suite of test scripts. The data generated from the tests will then be reconciled across both systems.
Best Practices
In accordance with the API Services Terms of Use Agreement signed by the partner before development has commenced, these guidelines are in place to ensure efficient and proper use of the Redeam API’s.
The following Best Practices must be adhered to by all Partners who wish to have an interface to the Redeam API’s.
Failure to follow these guidelines could jeopardize the interface and, if no action is taken by the provider to rectify non-compliance within 3 months from notification, reserves the right to disable the interface until such corrections have taken place.
Please note however, that if the non-compliance of the Partner puts the performance of the production environment at risk, Redeam reserves the right to disable the interface immediately
Channel API
You will use the Channel API to push inventory data into Redeam. Products, rates, availability, channels, and channel bindings are examples of the data managed by the endpoints in the Channel API. Redeam CS Engineers will work with the Partner to validate the data objects created.
Channel Binding
The first step to make a product available to a reseller using a Redeam Channel Gateway (RCG) is to create a Channel Binding. The channel binding provides you with an opportunity to specify which subset of Products and Rates should be made available to which resellers via the RCG. Every RCG is bound to a reseller’s channel; if the desired channel is not visible, please contact Redeam Support.
Partner API
Operators/Ticketing Systems will implement a set of endpoints according to the Partner API specifications and provide Redeam with those endpoints in the form of fully qualified domain name, and provide an API Key and API Secret (please note that Redeam does not currently support JWT Authentication. You will need to use the same authentication schema that Redeam is using on the Channel API for your Partner API (an API key and secret within the request headers)
The 3 Rate Types
- Reserved requires availability. This means, the reseller/OTA will have to check availability to see if the date/time they want and the quantity they need is available to reserve
- Freesale is just a typical entry for something like a museum that isn’t time dependent. The museum just has to be open for business. Freesale implies that there is no limit to how many they can sell
- Pass can be used multiple times. A "PASS"-type Rate operates under the same rules as FREESALE (no limits on capacity), but represents that the product may be redeemable more than once.
NOTE: If you are planning to sell through a Redeam Channel Gateway, please read the Channel Gateway Setup documentation thoroughly. There may be data requirements specific to that gateway that will hinder or prevent sales, if absent.
For resellers who already have an established API specification, Redeam may choose to connect to them by providing a gateway appliance for their existing service. These gateways (Redeam Channel Gateways) allow connected resellers to manipulate the Redeam Booking API service without having to create a comprehensive implementation of it. In general, a Redeam Channel Gateway is designed to accommodate the following reseller requests:
Availabilities - The reseller checks to see if a product is available for purchase on Redeam Holds - If a product is available, the reseller may attempt to reserve that product for its customer while they complete the checkout process Bookings - Once checkout is complete, the reseller will notify Redeam of the purchase
NOTE: If you are implementing Reserved type rates you must implement both the Availability and Hold endpoints.
Often, the reseller’s API is designed to create a remote booking based on a local operator catalog. This catalog is maintained by the reseller themselves, and will contain references to objects inside of the Redeam system. The reference used will depend on the reseller and their API capabilities, but in general this reference must resolve to a specific rate and product inside of Redeam. Performing this resolution is the responsibility of the Redeam Channel Gateway.
Redeam provides two methods for resolving reseller catalog references to Redeam objects - via the Product ID, or the Rate ID. Descriptions of how each identifier is resolved can be found in the Channel Gateway Setup section, along with a brief summary of their pros and cons.