MOVE Admin API
MOVE Backend APIs
Authentication
Fetch or create
Registration or login of a user is equivalent to obtaining the security tokens and initialising the frontend MOVE SDK with those tokens. In other words: use the registration request to obtain the user tokens, and then forward the user tokens to your app for initializing the MOVE SDK (using a MoveAuth object).
Create or fetch user
POST https://sdk.dolph.in/v20/user
This request enables users to either fetch an existing user or create a new one. The response object includes an access token, which can be used to initialize the MOVE SDK on your mobile device. This access token is valid for 5 days. The registration process supports both new and existing user IDs.
Headers
Authorization*
string
Basic <ProjectId>:<API-Key>
Request Body
{
"accessToken": "string",
"refreshToken": "string",
"userId": "string",
"audience": "string",
"installationId": "string",
"projectId": 0
}Fetch auth code
GET https://sdk.dolph.in/v20/user/authcode
The Auth Code is a unique identifier (UUID) used to initialize the SDK on the front end. This code is fetched from the backend and is valid for 10 minutes. By using the Auth Code, you simplify the process of integrating the SDK into your front-end application.
Headers
Authorization*
string
Basic <ProjectId>:<API-Key>
Query Parameters
userId*
string
The unique identifier for the user for whom the Auth Code is being requested.
Response Body
authCode*
string
UUID to initalize SDK valid for 10 minutes
Delete User
This request permanently deletes all user data associated with a specific user ID. Please note that the data is irreversibly lost.
DELETE https://sdk.dolph.in/v20/user
Deletes all user data permanently and all of its data
Headers
Authorization*
String
Basic <ProjectId>:<API-Key>
Request Body
userId*
String
Id of Move SDK user
projectId*
String
Id of MOVE SDK project
User Config
API for retrieving or modifying user configuration settings.
Fetch user config
GET https://sdk.dolph.in/v20/user/config
fetch the current config for the given user
Query Parameters
projectId*
String
Id of MOVE SDK project
userId
String
Id of Move SDK user
Headers
Authorization
String
Basic <ProjectId>:<API-Key>
Get user config history
GET https://sdk.dolph.in/v20/user/config/history
Retrieves the change history of a user's configuration settings within a custom time range.
Headers
Authorization
string
Yes
Bearer token or Basic authentication credentials
Query Parameters
projectId
integer
Yes
ID of the MOVE project
userId
string
Yes
Unique ID of the user
from
integer
No
Unix timestamp start value
to
integer
No
Unix timestamp end value
limit
integer
No
Maximum number of history entries
setting
string
No
If provided, only returns history entries for this specific setting, for example eco.co2EmissionBase
Request Body
No request body required.
Response
Get user device history
GET https://sdk.dolph.in/v20/user/device/history
Retrieves the Bluetooth / Beacon device registration history for a user within a custom time range.
Each returned entry represents one device lifecycle event, either REGISTER or DEREGISTER. Results are ordered by the event timestamp in descending order, meaning the newest event is returned first.
Headers
Authorization
string
Yes
Bearer token or Basic authentication credentials
Query Parameters
projectId
integer
Yes
ID of the MOVE project
userId
string
Yes
Unique ID of the user
from
integer
No
Unix timestamp start value
to
integer
No
Unix timestamp end value
limit
integer
No
Maximum number of history entries
Notes
Bluetooth devices are identified by
deviceId.Beacon devices are identified by the combination of
uuid,major, andminor.If no matching events are found for the specified time range, the endpoint returns an empty array.
Request Body
No request body required.
Response
history.kind*
string
Type of registered device (BLUETOOTH or BEACON).
history.type
string
Bluetooth device identifier. Present only when deviceType is BLUETOOTH.
history.eventTimestamp
string
Time the event occurred, in ISO 8601 UTC format.
history.name
string
Name of device
history.deviceId
string
Bluetooth device identifier. Present only when deviceType is BLUETOOTH.
history.uuid
string
Beacon UUID. Present only when deviceType is BEACON.
history.major
integer
Beacon major value. Present only when deviceType is BEACON.
history.minor
integer
Beacon minor value. Present only when deviceType is BEACON.
Patch user config
PATCH https://sdk.dolph.in/v20/user/config
update the current config for the given user
Query Parameters
userId*
String
Id of Move SDK user
projectId*
String
Id of MOVE SDK project
Headers
Authorization*
String
Basic <ProjectId>:<API-Key>
User scores
This API enables you to retrieve scores for a specific user, with a focus on Exposure to Risk (ETR) and Move scores. Detailed parameters and responses are provided below
Exposure to risk
Why It's Important: The more time you spend driving, the greater your exposure to the risk of accidents. This risk is influenced not just by the distance traveled but also by the duration and timing of each trip. For instance, many accidents occur within the first few minutes of a drive, and the risk increases during extended journeys. Avoiding very short trips and taking breaks on longer ones can help mitigate this risk.
How It Works: The ETR Score is calculated based on the number and duration of your trips. Additionally, the type of roads you travel on is factored into the score, with highways being the safest and rural roads posing higher risks. This score helps you understand and manage your exposure to risk, guiding you towards safer driving habits.MOVE Score
MOVE Score
Why It's Important: The MOVE Score is your total risk score, offering a clear and comprehensive understanding of your driving safety. It reflects your overall driving habits, combining key factors that influence driving risks.
How It Works: This score merges your MOVE IQ, which evaluates your driving style, with your ETR, which considers how often and how long you drive. By bringing together these aspects, the MOVE Score provides a complete overview of your driving safety, taking into account both the quality of your driving and your time on the road.
User scores
GET https://sdk.dolph.in/v20/scores/user
Fetch scores of user, at the moment only ETR and Move score is supported.
Query Parameters
userId*
String
Id of Move SDK user
projectId*
String
Id of MOVE SDK project
startTs*
Integer
Start timestamp for the score retrieval.
endTs*
Integer
End timestamp for the score retrieval.
timeframe
String
Timeframe for the score calculation. Available values include DAILY, WEEKLY, MONTHLY, YEARLY, and NONE.
Headers
Authorization*
String
Basic <ProjectId>:<API-Key>
This example response includes Exposure to Risk and Move scores along with historical data for various timeframes (daily, weekly, monthly, yearly).
Access Management
Block / Unblock User
Use this API endpoint to block or unblock a MOVE SDK User. When a user is blocked, the MOVE SDK Backend will return an HTTP Error 403 for all subsequent requests made by the blocked user.
Block or unblock Move SDK user
POST https://sdk.dolph.in/v20/access/block
Request Body
projectId*
Int
userId*
String
block*
Boolean
Last updated