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
  • Our Suite of Platform Products
  • Search
  • Firehose
  • Our Platform Products in Action
  • Hints & Tips
  1. Using the Platform

imin's Platform Products

PreviousIntroduction to the imin PlatformNextAuthentication

Last updated 7 months ago

Our Suite of Platform Products

Search

imin's product is made up of a suite of APIs that enable you to easily access specific data from within the imin Platform that matches your requirements. Search comprises three APIs:

  • An ;

  • A ; and

  • A .

By choosing from the range of query parameters available across the APIs, you can return data based on geographic location, start time, type of activity, price and many more.

You must not use the Events API to collect more information than necessary to respond to an end user query, or store or scrape data other than as expressly permitted by us.

If you would like to temporarily store copies of larger data sets for efficiency or other purposes, please ask us about Firehose and our other service options.

Firehose

The imin gives you an alternative way to power your applications without having to use Search. Rather than using query parameters like those found in Search, you have access to a "feed" of all the data in our Platform. This is compatible with the and published using the .

Unlike Search, the Firehose is not a search API. It is a "feed" of all data, which means that all filtering needs to be done client-side.

Our Platform Products in Action

Check out the following examples of the imin Platform in action:

Hints & Tips

Decathlon's

London Sport's

Manchester City Council's

British Paralympic Association's

Looking for advice on best practice when building against out Platform? Want to know how you can provide activity search or the best way to display schedule information? Then hopefully our hints & tips with help you .

Search
Events API
Facilities API
Places API
Firehose
OpenActive Modelling Specification
OpenActive Paging Specification
PLAY
Get Active
MCRactive
Parasport
Get the Best Out of Search