The imin Platform
2.0.0
2.0.0
  • Introduction to the imin Platform
  • Using the Platform
    • imin's Platform Products
    • Authentication
    • Our Platform Data
      • Understanding Responses
      • Namespaces and Extensions
      • Defensive Data Consumption
      • Mocking the Interface
  • platform products
    • Search
      • imin Events API
        • Events API Reference
        • Virtual & Physical Sessions
        • Concepts
          • EventSeries
          • ScheduledSessions and eventSchedules
          • Activities and Collections
            • Activities
            • Activity Concept Collections
          • Accessibility Support
          • Prices
        • Filters
          • Modes
          • Age Ranges
          • Dates and Times
          • Activities and Concept Collections
          • High Frequency Sessions
      • imin Facilities API
        • Query Parameter Search
          • Mandatory Query Parameters
            • mode=discovery-geo
            • mode=upcoming-slots
          • Optional Query Parameters
        • ByID Search
          • FacilityUse By-ID
          • Slot By-ID
        • FacilityUses and IndividualFacilityUses
        • Slots
        • Facilities Slot Booking
      • imin Places API [BETA]
        • Example Request & Response
    • Firehose
      • Introduction to the Firehose
      • Accessing the Firehose
      • Firehose Usage Policy & Restrictions
      • Firehose and Search
      • Bookable Firehose Feeds
      • Bookable Sellers Feed
      • Attribution Catalog Endpoint
    • Live Timetables
      • Pre-Requisites: Open Data Feeds
      • The Onboarding Process
        • 1. Ensuring your Data Offers the Best User Experience
        • 2. Setting up and Embedding your First Timetable
        • 3. Setting up the Rest of your Timetables
        • 4. Activating Booking via Guest Checkout
      • Features Available Upon Request
      • Styling the Live Timetables
      • FAQs
    • Data Dashboard
  • incorporating book and pay
    • imin Branded Checkout
      • Introduction
      • Setup
        • Information We Require From You
        • Actions You Need to Complete
      • Authenticated Checkout
        • Testing [BETA]
        • 👪Group Booking [BETA]
      • Standalone Checkout
      • Firehose and Checkout [BETA]
        • Loading the Checkout via Firehose
    • imin Booking Platform
      • Customer Account Management
        • Create Customer Account
        • Update Customer Account
        • Get Customer Account
        • Delete Customer Account
        • Example Scenario
        • Payment Card Management
        • Linked Accounts
        • Entitlement
          • Evidence Requests
          • Entitlement Pricing in Search
          • Entitlement Pricing in Checkout
        • Access Pass
        • Webhooks
      • Orders
        • Order History
        • Order (by ID)
        • Cancellations & Refunds
      • Upcoming OrderItems
      • Receipt (by ID)
  • imin and booking systems
    • Seller Onboarding
      • API
  • HINTS & TIPS
    • Get the Best Out of Search
      • Displaying Schedule Information
      • URLs and Offering a Call to Action
      • Searching by Activity
      • Your Search Results and HighFrequencySessions
      • Customer Specific Images
  • Info for Data Publishers
    • Your RPDE Feed & the imin Platform [BETA]
      • Providing Places Data [BETA]
      • Providing Schedule Information [BETA]
Powered by GitBook
On this page
  • Timetable Usability
  • Is our timetable able to work with screen readers/how accessible is it?
  • Why are we seeing a CORS policy error and no data in our timetables?
  • Additional Features
  • Can you show the locations where sessions are taking place (e.g. main pool & teaching pool)?
  • Can we show what exact locations (e.g. pitch 3) are represented in the facilities timetable rows?
  • Booking & Deep-Links
  • Gladstone: Does member login take the user to the specific session in Gladstone (Connect or GO)?
  • Gladstone: I am able to deep-link into Gladstone GO from my sessions timetable. Can I do the same with my facilities timetable?
  • Booking & Payments
  • When using the imin Branded Checkout, can we use a payment gateway of our choosing?
  • Privacy, Data Security & Online Transactions
  • Open Data Feeds
  • Data Storage Locations (only relevant for customers using our Branded Checkout)
  • Your API Key and Your Codebase
  • Accessibility
  • As an organisation, we are required to meet certain standards for accessibility. Does your timetable cater for this?
  1. platform products
  2. Live Timetables

FAQs

PreviousStyling the Live TimetablesNextData Dashboard

Last updated 6 months ago

Timetable Usability

Is our timetable able to work with screen readers/how accessible is it?

Our timetable is compatible with screen readers such as the Apple iPhone screen reader.

Why are we seeing a CORS policy error and no data in our timetables?

You might receive an error like this stating that the Timetable's API call to our Platform has been blocked:

If you receive a message like this, we recommend verifying that your API key is correctly included and properly used in the API call.


Additional Features

Can you show the locations where sessions are taking place (e.g. main pool & teaching pool)?

Yes we can, but this requires some custom work on our side. Please get in touch with us so we can understand what your requirements and provide you with a quote for the work.

Can we show what exact locations (e.g. pitch 3) are represented in the facilities timetable rows?

We are unable to currently display this in the Facilities Timetable. However, there are workarounds such as including this information in the description, so please share your requirements with us and we will assist you in the best way possible.


Booking & Deep-Links

Gladstone: Does member login take the user to the specific session in Gladstone (Connect or GO)?

Yes, the button should function as a deep-link taking the user directly to their chosen session.

For Gladstone Connect, if the user isn't logged in, it will take them to the Gladstone log-in page and then, once logged-in, it should take the user automatically to the relevant page within Gladstone.

For Gladstone GO, the user will land on the specific page, ready to add to the basket, without needing to log-in first.

Gladstone: I am able to deep-link into Gladstone GO from my sessions timetable. Can I do the same with my facilities timetable?

We have completed the work to ensure the Sessions Timetable can deep-link into GO Book. However, one remaining task is to enable deep-linking from the Facilities Timetable into Gladstone GO. In the meantime, if you're still using the Connect module, members can can login and book in the usual way.

Booking & Payments

When using the imin Branded Checkout, can we use a payment gateway of our choosing?

At present, we exclusively use Stripe as our payment gateway, though this may change in the future. Stripe is known for its ease of setup and use, and feedback from finance teams we've worked with highlights its user-friendly interface and robust security.


Privacy, Data Security & Online Transactions

Your DPO may have questions to do with data privacy and security for the Live Timetables. Below are some helpful answers to common questions from a DPO.

Open Data Feeds

  • Your open data feed should contain no personal data as it is simply showing activity data such as time, price, location of an activity.

  • Your open data feed is published using a creative commons CCby4 licence. This means that it can be used by anyone for any purpose so long as they attribute it to your organisation.

  • There are no restrictions on storage of this data other than respecting your wishes for it to be deleted, which happens automatically. For example, when you cancel a session within your booking system, it will be removed from your open data feed and, therefore, we must remove it from our end, wholesale.

Data Storage Locations (only relevant for customers using our Branded Checkout)

  • All of our subprocessors are in the EU, and for those that aren’t, we ensure we have Standard Contractual Clauses signed and documented to ensure data compliance equivalence.

  • We regularly store data related to payments and transactions in the form of:

    • The logging procedures of product for reporting, de-bugging; and

    • Alerting internal team members (e.g. via Slack).

  • We are required to store this information because:

    • In the event of an issue or where we are required to manually cancel or issue refunds, we need a history of bookings and transactions;

    • In the event of a dispute, we need certain information about a booking; and

    • In accordance with UK laws, financial transaction history must be stored for a certain period of time.

Your API Key and Your Codebase

It is possible to store your unique API key in a CMS like WordPress or a custom implementation so that it is not hard coded into your codebase. You can do this by retrieving the API key from a database table or configuration and assigning it to the apiKey variable.

The example code snippet below, which is specifically intended for WordPress, retrieves the imin_api_key from the options table and assigns it to the apiKey variable:

apiKey: <?= get_field('imin_api_key', 'option') ? "'" . get_field('imin_api_key', 'option') . "'" : "''" ?>,

The above snippet only works for WordPress.

It uses the ternary operator to ensure that if no API key is found, the apiKey is set to an empty string. In this instance:

  • get_field('imin_api_key', 'option') retrieves the API key stored in the options (make sure this key is properly set in your configuration); and

  • ? : (the ternary operator) checks whether the API key exists:

    • If it is found, it outputs the key wrapped in single quotes.

    • If it is not found, it assigns an empty string.

Although the key is wrapped in single quotes, be cautious when outputting sensitive information directly into JavaScript or the frontend. Consider additional security measures such as environment variables or server-side handling.

The empty string ('') is used as a fallback if no key is present. Ensure this does not lead to unexpected behavior in the application (e.g. failed API requests).


Accessibility

As an organisation, we are required to meet certain standards for accessibility. Does your timetable cater for this?

Yes. The scripts for both the Sessions and Facilities Timetable code includes the information required for the iframes to have title attributes to cater for accessibility requirements. This will allow you to add alt-text to your timetables.

Please refer to our , and information.

For further information on using your imin API key, please refer to our page.

subprocessor's list
privacy policy
security/compliance
Authentication