For Registration/Technology Partners

What is RegLink and the OpenAPI?

Lanyon Passkey’s Event Connector OpenAPI (API) allows third party applications, such as registration systems, to interact with the Lanyon Passkey system. The RegLink Open API supports two primary communication methods: REST (browser-based) and web services.  Browser-based calls utilize basic formatted URLs to communicate information to Lanyon Passkey while our web service APIs utilizes a more robust set of XML messages to send and receive data.

Most third party applications can utilize the browser-based calls, which can simplify the development effort needed to implement the solution; however, web service calls are also available if this method is needed or preferred.

While many features are available with the API, the license model used by Passkey customers may limit available functionality. The two available license models are:

  • RegLink 1-Way – Information is only sent from the third party application to Passkey. Passkey doesn’t return any data to the system making requests.
  • RegLink 2-Way – Information is transferred between systems in either direction based on business needs.

If the meeting planner is working with a hotel directly to enable RegLink, the 2-Way license is included.  If you are working directly with a meeting planner or CVB/Destination you should have them verify which license they have. If they need assistance they can contact support@passkey.com.  There is no direct cost to the registration company or technology provider if a customer is involved.  If you are interested in partnering with Passkey and don’t have a customer – either a hotel or meeting planner/CVB/destination – involved, please contact sales@passkey.com.

Once a partner has successfully implemented the API they can be listed on our partner page.  Sign-up today to get started!

Getting Started

Once you sign-up, you are given access to the API.  The first step in planning a successful implementation is determining the type of RegLink integration you need.

There are two main types of RegLink integrations:

  • RegExpress and Basic – Allows a third party application to send basic attendee information to Lanyon Passkey.  Housing reservations are then completed through the Lanyon Passkey Attendee Website for the applicable Lanyon Passkey event. At the conclusion of the registration process, attendees can be forwarded the Lanyon Passkey Attendee Website with details auto-populated to streamline the housing reservation process. This business process can be completed using browser-based calls or web service/XML messages. With RegExpress and Basic integrations, the Lanyon Passkey attendee website is always utilized to complete reservations for housing.

Note: RegExpress is not intended to be used with RegLink-related Lanyon Passkey reporting. However, Basic can deliver that feature/functionality.

RegLink Callback Service (Requires RegLink 2-Way License)

The API includes an optional feature allowing Lanyon Passkey to send a simple message to a third party application indicating when a reservation is created, modified, or canceled. This service is referred to as a “Callback” in Lanyon Passkey.  Callbacks are often used as a mechanism allowing a third party system to store the Lanyon Passkey housing Acknowledgment number which can then be used to provide attendees with a URL they can use to modify their reservation.

RegLink Reporting

Several reports are available in Lanyon Passkey providing details for an event and the registration process. These reports are especially useful in identifying attendees who have registered but have not yet reserved housing within Lanyon Passkey or attendees who have booked housing in Lanyon Passkey, but have not registered. The accuracy of these reports is contingent upon successfully implementing the overall application of the API and as such, should be carefully considered if this type of reporting is important to the customer. It is important to note that the RegExpress integration does not support RegLink-related reporting in Lanyon Passkey.

The following RegLink-related reports are available within the Lanyon Passkey application:

  • Registered – Hotel Booked – Reports all bridge IDs which have had a hotel reservation completed for a specific event. Assuming that the registration system creates a Bridge ID for all registrants, this report shows all registered guests who have completed a housing reservation.
  • Registered – No Hotel Booked – Reports all records in the bridge that have not completed a hotel reservation for a specific event (i.e., the record exists in the bridge but does not yet have an associated Passkey Acknowledgement Number attached).
  • Hotel Booked – No Registration – Reports all records in the Housing database that do not have an associated bridge ID for a specific event. In these cases, the reservation was created directly using the housing user interface and was not initiated through a RegLink call. This is called an “Orphaned” housing record because the hotel reservation and registration records do not share a Bridge ID. For more information, see section below on Linking Orphaned Records.

Next Steps

In order to access the API we simply request you fill out the registration form and agree to the terms and conditions and then you are free to get started.  Our API contains working samples and event details so you can hit the ground running.  If you run into any issues please contact us and we can assist you.

Supported Features

The RegLink Open API supports the following operations:

  • Create, modify, or cancel Lanyon Passkey attendee information, for example name, address, and other details (this is known as a “Bridge Record”). This information is stored in Lanyon Passkey and can be utilized to create a reservation as needed.
  • Transfer attendee information and redirect attendee to the appropriate Lanyon Passkey Attendee Website via a single-step URL (RegExpress)
  • Provide an attendee-specific URL which presents the Lanyon Passkey Attendee Website and can default the attendee and other information into the booking process.
  • Provide a message back to a third party application when reservations are created, modified, or canceled (known as RegLink’s “Callback Service”)
  • Fetch availability data to use in creating reservations using web service calls or to use in publishing dynamic housing availability information such as a housing widget, for example.
  • Create, modify, or cancel reservations
  • Retrieve reservation details

The table below displays the supported RegLink features for each integration method.  Licensing is the responsibility of the Hotel or CVB/Destination.  All hotels which are customers of Passkey have the 2-Way license, however that is not the case with Destination/CVB’s.  If you have any questions on what can be supported please send an email to passkeysupport@lanyon.com for more details.

Feature

License Required

Browser “URL” Based    Call

Web Service / XML

RegExpress (Single-step Create Bridge and Redirect to Lanyon Passkey Attendee Website)NOTE:  This method does not allow for accurate RegLink reporting.

1-Way

X

N/A

Send Lanyon Passkey Attendee Information (Bridge)

1-Way

X

X

Update Existing Attendee Information (Bridge)

1-Way

N/A

X

OpenLanyon Passkey Booking Engine with Attendee Information Defaulted   for Create, Modify or Cancel Reservation

1-Way

X

N/A

Provide “Callback” Message When Reservation is Created,   Modified, or Canceled

2-Way

X

X

Search for Availability or Provide Housing Widget

2-Way

N/A

X

Create, Modify, or Cancel Reservation

2-Way

N/A

X

Retrieve Reservation Details

2-Way

N/A

X