Overview
Service Configuration, labeled Service Config in App Manager, allows you to manage how your environment connects to your back-end systems. It contains your Eleos Platform Key, web service URLs, Telematics Configuration, and API keys. Service Config is located under App Administration > Service Config in App Manager and requires the App Administration permission.
NOTE: All Service Config settings are environment-specific. Changes apply only to the environment you are currently working in.
IMPORTANT: Changes to Service Config are recorded in the Audit Log, including changes to web service URLs, service integration types, and the Eleos Platform Key. For more information, refer to the Audit Log Guide.
Eleos Platform Key
The Eleos Platform Key is a secret value included in every request the Platform sends to your web services. Your services use it to confirm that a request came from Eleos and should reject any request with an invalid key.
For more information refer to our Platform Authentication Guide.
Updating the Eleos Platform Key
Update the key if you suspect it has been compromised.
Navigate to App Administration > Service Config within App Manager
Enter your new key in the Eleos Platform Key field
Store the new key securely
Select Save
Update your back-end systems to accept the new key
WARNING: The new key takes effect immediately upon saving. Until your back-end systems are updated, they reject requests from the Platform, and features that depend on your web services stop working in the mobile app.
Web Service URLs
Web service URLs tell the Platform where to send requests so it can sync data and trigger actions based on mobile app activity. You build and maintain the services at these URLs, and you only need to configure the services for the features you use.
Web Service | Platform Use | Guide |
|---|---|---|
Authentication Service | Verifies user logins and active sessions | |
Driver Status Service | Retrieves each user's duty status for In-Motion Locking when no telematics integration is used | |
Load Service | Retrieves the loads and stops displayed to users | |
Messaging Service | Delivers messages and form submissions sent by users | |
Payroll Service | Retrieves the earnings data displayed to users | |
Routing Schema Service | Retrieves your routers and routing options for Pluggable Routing | |
To Do Service | Syncs To Dos assigned to users, and retrieves completed To Dos from users | |
Trip Change Service | Delivers trip changes, location updates, and navigation issue reports | |
Truck Status Service | Retrieves the status and location of a user's asset for My Truck |
Updating a Web Service URL
Navigate to App Administration > Service Config within App Manager
Enter the URL for the service you are updating in the Service Configuration section
Select Save
IMPORTANT: A URL that does not respond breaks the features that depend on that service.
TIP: Test URL changes in a test environment before applying them to production.
Telematics Configuration
The Platform works with any telematics or Electronic Logging Device (ELD) provider. The Telematics Configuration section is needed only for a direct integration, which is currently available for Geotab and Geotab-based platforms such as AT&T Fleet Management and T-Mobile SyncUP FLEET. With a direct integration, the Platform uses an administrator account in your Geotab database to create Geotab accounts for users automatically.
If you use a different provider, you do not need to configure this section. Your provider is still supported: send each user's duty status to the Platform through your Driver Status web service, and features that rely on duty status, such as In-Motion Locking, work the same way. For details, refer to the ELD/Telematics Integrations Guide.
Field | Description |
|---|---|
Federation | Your telematics provider |
Database | The name of your provider database |
Username | The username of an administrator account in your provider's system |
Password | The password for that account |
Integration Mode | Legacy retrieves hours of service (HOS) data from Geotab's servers. |
IMPORTANT: The account you enter must have Administrator security clearance in your provider's system. Without it, the integration cannot create accounts for users.
API Keys
API keys authenticate the requests your systems send to the Eleos API, such as sending messages to users or retrieving data from the Platform. You can create a separate key for each system that connects to the Platform. That way, you can tell which system made a request and disable one key without affecting the others.
For more information, refer to our API Keys Guide.
Creating an API Key
Navigate to App Administration > Service Config within App Manager
Select the Add a new key button in the API Keys section
Copy the key and store it securely before closing the pop-up
IMPORTANT: An API key is shown only once, when it is created. If you close the pop-up without copying it, there is no way view it again.
NOTE: Each environment supports up to 100 API keys.
Disabling an API Key
Disable a key immediately if you suspect it has been compromised. Requests that use a disabled key are rejected immediately.
Navigate to App Administration > Service Config within App Manager
Locate the desired key in the API Keys section
TIP: You can determine the correct API key by the prefix. The rest of the API key is masked.
Select Disable