Setup venues and POI

Venues are the physical locations where guests use the accesso Guest Experience platform to interact with our brands. They are the container for many data types, including points of interest (POI), maps, and calendar events.

Finding venues

Some applications are hard-coded to work only in one or more pre-defined venues. Other applications need to discover their target venues dynamically, as new venues may appear or be retired over time.

To get the current list of venues dynamically we can call:

1
2
3
curl -X GET \
  https://api.{region}.te2.io/api/v1/public/venues \
    -H 'Authorization: Bearer {token}'

Where:

• Authorization: JWT token returned during authentication.

This will give us the venueName and id for all venues currently loaded in the platform. The id is used in subsequent calls to get more information about a particular venue.

Getting venue details

Now that we have our venue id we can get detailed information about it:

1
2
3
curl -X GET \
  https://api.{region}.te2.io/rest/venue/{id} \
    -H 'Authorization: Bearer {token}'

This result contains a lot of high-level information about the venue.

The most commonly used fields are:

• name: The guest-friendly name for this location.
• timeZone: The tz database name for this venue’s time zone. For example, US/Pacific or America/Mexico_City.
• location: The center point lat and lon for this location, and the radius that the platform uses to determine if users are in or out of the venue.
• defaultMapId: For venues with multiple maps, the map that should be used by default.
• details: An array of extension data associated with this location. The id, label, and description fields can be used by apps to add any data that they need to the venue object.

The full venue response data can be found in the Venue API.

Fetching points of interest

We can also fetch a list of all the child points of interest (POI) within a particular venue:

1
2
3
curl -X GET \
  https://api.{region}.te2.io/api/v2/pois?venueId={id} \
    -H 'Authorization: Bearer {token}'

This will return an array listing all POI at this venue, including detailed information about each one.

The most commonly used fields are:

• id: The unique identifier for this POI.
• name: The guest-friendly name for this POI.
• description: The guest-friendly description for this POI.
• displayCategories: The categories under which this POI should be displayed.
• images: An array of images to display for the POI.
• attributes: An array of attribute values about the POI. This is used to track POI capabilities (e.g., does it support a fast lane?), requirements (e.g., no riders under 42 inches tall), or other extension data.
• location: The lat and lon coordinates for this POI.

The full POI response data can be found in the Point of interest API reference.

You can also fetch information about a single POI by ID:

1
2
3
curl -X GET \
  https://api.{region}.te2.io/api/v2/pois/{poiId} \
    -H 'Authorization: Bearer {token}'