I. OxeConnect
OxeConnect is the OxeFit API and is intended for specialized integration between OxeLead and other third-party entities/services when access to certain user account data is needed.
It enables users with the API User Role to access their OxeLead data from external applications for data synchronization or customized user experience.
See Access Tokens and Access Scopes below for info on limitations, permissions, and security measures.
II. Access Tokens
A Personal Access Token is an API key that a user authorizes to allow a third-party the ability to access their data. In conjunction with OxeConnect, access pertains to their OxeLead user data (such as training activity and analytics etc.) where different "Tokens" govern the different levels of permission.
Data access is automatically limited based on the role(s) assigned to the owning user. For example: A Trainer may access training data for members within the organization, while users without that role may not.
In addition to role-based access control, Access Tokens can also be limited by modifying the Access Scope for the token itself (see below).
III. Access Scopes
While user roles and Access Tokens control the level of data that can be accessed within an organization, Access Scopes enforce additional limits on the type of data that can be accessed when using a particular token. This allows different tokens to be created with different combinations of scopes to provide the least amount of access required for each application.
Profile (Read-only):
Allows the user profile for the Personal Access Token owner to be read from the API.
Account (Read-only):
Allows billing and organization information (including member profile data) to be read from the API.
Training Data (Read-only):
Allows session and exercise history to be read from the API.
IV. How To Add Access Token & Set The Scope(s)
Reminder: Must have API User Role to add Access Token.
Follow directions below:
+ Add Access Token
Go to My Tokens under SETTINGS tab. Click the + Add Access Token button. | |
Enter Credentials
Enter Token Name. Choose Lifespan of Token. Select Scope(s).
| |
Finalize
Click Create button. | |
View New Access Token Two places to view:
01. My Tokens (Settings tab)
02. Access Tokens (Admin tab)
|