This guide describes migrating from XML or browser-based RegLink APIs to the REST-based APIs.
Getting Started
If you use an existing legacy API for passkey (XML or browser-based) to access Cvent’s REST API, reach out to the Passkey support team to get REST API credentials.
Browser APIs
This section describes the RegLink Browser APIs and shows what provides the same capability in the new REST API.
| Browser APIs | Equivalent REST API |
|---|---|
| CreateBridgeHTTP | Create Reservation Request |
| CreateBridgeandRedirect | Create Reservation Request |
| GetForRedirectResWeb | Create Reservation Request (Response) |
| GetForRedirectResDesk | Create Reservation Request (Response) |
| ModifyReservationResWeb | Get Reservation |
| ModifyReservationResDesk | Get Reservation |
| CancelReservationResWeb | Get Reservation |
| CancelReservationResDesk | Get Reservation |
Note: Instead of a separate APIs for redirecting guests, the Create Reservation Request API returns a guest URL in the response.
XML API APIs
This section describes the RegLink XML APIs and shows what APIs provide the same capability in the new REST API.
| Legacy XML APIs | Equivalent REST API |
|---|---|
| GetEventDetails | Get Housing Event Info & Get Housing Event Hotels & Get Housing Event Hotel & Get Event Hotel Availability & Get Housing Event Room Types & Get Room Type Details & Get Room Type Inventory |
| GetAvailability | Get Event Hotel Availability |
| GetReservation | Get Reservation |
| CreateBridge | Create Reservation Request |
| ModifyBridge | Update Reservation Request |
| CancelBridge | Cancel Reservation Request |
| GetBridge | Get Reservation Request |
| CreateReservationFromBridge * | Create Reservation Request & Link Reservation |
| GetHousingDetails | Get Housing Event Info & Get Housing Event Hotels & Get Room Type Details |
- * No exact API matches CreateReservationFromBridge. This flow involves using the Create Reservation API and then linking the Bridge and Reservation together with the Link Reservation API.
Future Roadmap
Three upcoming REST API endpoints extend the capability of Passkey REST APIs:
- Create Reservation
- Modify Reservation
- Cancel Reservation
The Passkey callback mechanism remains unchanged.
Last updated on