ExorLive Users API
A "user" in this context can be either:- Instructor: A Professional user that creates exercise programs.
- Administrator: A user with higher privileges than an instructor. Administrates other users.
- Contact With Login: A client/patient which can use the ExorLive GO mobile app.
- Contact: A client/patient without any access. Is just an entry in the contacts-list of the instructor.
Description
- Lookup users based on email, customid, personnummer, ssn, etc.
- Create or update a user in ExorLive.
- Set the event callback URL.
Demo
A simple demo-application written in Javascript is found here: https://exorlive.com/test/UserDemo.htmlThe endpoints
Each call expects two values in the HTTP header:- "ExorLive-Client": The "clientname" to be agreed upon with ExorLive AS.
- "Authorization": "Bearer accesstoken"
New swaggerdocumentation.
SetUser
Call this to create or update a user object.Name | SetUser | ||||||||||||||||||||
Url | https://exorlive.com/api4/user/setuser | ||||||||||||||||||||
Method | POST | ||||||||||||||||||||
contentType | application/json; charset=utf-8 | ||||||||||||||||||||
Sample input |
|
Lookup User
Call this to find one or more user objects.Name | LookupUser |
Url | https://exorlive.com/api4/user/lookupuser |
Method | GET |
Input |
|
Sample calls |
|
Set event callback URL
Specify a URL that will receive http-requests when certain events happens.Name | SetEventCallbackUrl |
Url | https://exorlive.com/api4/user/SetEventCallbackUrl |
Method | GET |
Input |
|
Sample calls |
|
Remarks |
The URL is stored for the organization of the logged in user and applies to any events for that organization. When an event is triggered in ExorLive, a http-request is fired to the URL registered. ExorLive will append these parameters to the URL:
Callback URL:
https://mycomain.com/events/
ExorLive will send:
https://mycomain.com/events/?event=workoutReady&userId=1234
Callback URL:
https://mycomain.com/events/?source=exorlive
ExorLive will send:
https://mycomain.com/events/?source=exorlive&event=workoutReady&userId=1234
|