Skip to main content

Introduction

This guide aims to explain how to use the Insiders API through definitions and examples.

In a nutshell, the purpose of the API is to give access to Insiders's sensor data on behalf of their users. Data and statistics can either be live streamed using Websockets, or retrieved afterwards using regular HTTP requests.

The API provides 4 category of resources: Users, Devices, Activities and Time frames. Users can have one of two User Roles: Athlete or Manager. Devices represent the physical devices. User authentication is done using OAuth 2.0, which allows API clients (Applications) to access user data on behalf of the Athlete. Activities represent a sport session (e.g. competition game or training) for which data from one or several Athletes has been or will be recorded. Data and analytics from the Activity can be retrieved for a specific Time frame. Multiple Time frames can be defined for a single Activity.

info

We may use the terms Clients, Applications or AMS (for Athlete Management Systems) to refer to any Application registered on the API.