Eleos Tech Documentation

https://docs.eleostech.com
Admin
Comprehensive documentation for the Eleos Mobile Platform, a customizable mobile application...
Tokens:19,005
Snippets:327
Trust Score:8.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Open App to Dashboard

Source: https://docs.eleostech.com/docs/guide-deep-linking

Use this URL to launch the Eleos mobile app directly to the dashboard. Ensure only one Eleos app is installed to avoid unexpected behavior.

```url
eleos://dashboard
```

--------------------------------

### Retrieve App Manager SAML Values with GET /saml

Source: https://docs.eleostech.com/docs/app-manager-saml-sso

Send a GET /saml request after configuring your IdP to obtain the Assertion Consumer Service (ACS) URL and Service Provider (SP) Entity ID. These are required for your IdP configuration.

```json
{
  "acsUrl": "https://appmanager.example.com/saml/consume",
  "spEntityId": "https://appmanager.example.com/saml"
}
```

--------------------------------

### Construct Load Link

Source: https://docs.eleostech.com/docs/guide-deep-linking

Build a URL to route users to a specific load within the Eleos app. Requires version v1.57 or newer. Users must be logged in and have the app installed.

```url
https://fleetmobile.app/[division_code]/loads/[order_number]
```

```url
https://fleetmobile.app/fleet-div/loads/123456
```

--------------------------------

### Retrieve App Manager SAML Values

Source: https://docs.eleostech.com/docs/app-manager-saml-sso

Send a GET /saml request after configuring your IdP details to retrieve the App Manager SAML values needed for your IdP configuration.

```APIDOC
## GET /saml

### Description
Retrieves App Manager SAML configuration values required for IdP setup.

### Method
GET

### Endpoint
/saml

### Response
#### Success Response (200)
- **ACS URL** (string) - Assertion Consumer Service URL for your IdP.
- **SP Entity ID** (string) - Service Provider identifier for your IdP.

#### Response Example
```json
{
  "ACS URL": "https://appmanager.example.com/saml/acs",
  "SP Entity ID": "https://appmanager.example.com/sp"
}
```
```

--------------------------------

### SAML Conditions Element Example

Source: https://docs.eleostech.com/docs/app-manager-saml-sso

This XML snippet shows the required structure for the SAML Conditions element, including NotBefore, NotOnOrAfter, and Audience restrictions. Ensure your IdP generates this correctly.

```xml
<saml:Conditions NotBefore="{ConditionsNotBefore}" NotOnOrAfter="{ConditionsNotOnOrAfter}">
  <saml:AudienceRestriction>
    <saml:Audience>{Audience}</saml:Audience>
  </saml:AudienceRestriction>
</saml:Conditions>
```

--------------------------------

### Outbound Message Payload Example

Source: https://docs.eleostech.com/docs/guide-outbound-messaging

This JSON payload represents a read event for an outbound message. It includes timestamps for when the message was composed and read, the username, message type, and body.

```json
{
    "direction": "outbound",
    "username": "JDOE",
    "composed_at": "2026-01-16T16:34:12+00:00",
    "read_at": "2026-01-16T16:34:24+00:00",
    "message_type": "text",
    "body": "Test."
}
```

--------------------------------

### Configure Mobile SSO with PUT /sso_configs/{code}

Source: https://docs.eleostech.com/docs/guide-mobile-sso-configuration

Use this endpoint to create or update your Mobile SSO configuration by providing your IdP's client ID, client secret, and relevant endpoints. Discovery is not supported, so authorization and token endpoints must be explicitly provided.

```bash
curl -i --location --request PUT 'https://platform.driveaxleapp.com/api/v1/sso_configs/AZURE' \
--header 'Authorization: {{Eleos API Key}}' \
--header 'Content-Type: application/json' \
--data '{ 
        "archived": false, 
        "authorization_endpoint": "https://login.microsoftonline.com/9b7f4c22-3e3d-4e6d-910f-123456789abc/oauth2/v2.0/authorize", 
        "button_color": "cae1fd", 
        "button_color_dark": "f74a8f", 
        "client_id": "a23cd456-78e9-41f2-934b-abcdef123456", 
        "client_secret": "PzJ9B~a1kL2vNdsX4WgTrhSeZ8MPqLo89-XYz123", 
        "enabled": true, 
        "issuer_url": "https://login.microsoftonline.com/9b7f4c22-3e3d-4e6d-910f-123456789abc/v2.0", 
        "label": "Login with SSO", 
        "scopes": [ 
            "email", 
            "openid" 
        ], 
        "title": "Azure SSO", 
        "token_endpoint": "https://login.microsoftonline.com/9b7f4c22-3e3d-4e6d-910f-123456789abc/oauth2/v2.0/token" 
    }'
```

--------------------------------

### Initial Login

Source: https://docs.eleostech.com/docs/guide-user-authentication

This endpoint is used by the mobile app when a user first enters their username and password. The system verifies the credentials and, if valid, generates a unique api_token to send back with user and configuration data.

```APIDOC
## POST /authenticate

### Description
Verifies user credentials (username and password) and generates an API token upon successful authentication.

### Method
POST

### Endpoint
/authenticate

### Request Body
- **username** (string) - Required - The user's username.
- **password** (string) - Required - The user's password.

### Response
#### Success Response (200)
- **api_token** (string) - A unique token for authenticating future requests.
- **full_name** (string) - The full name of the user.
- **dashboard_code** or **dashboard** (string/object) - Configuration for the user's dashboard.
- **menu_code** or **menu** (string/object) - Configuration for the user's menu, must include a 'settings' item.
```

--------------------------------

### Configure SAML SSO with PUT /saml

Source: https://docs.eleostech.com/docs/app-manager-saml-sso

Use the PUT /saml endpoint to enable SSO and provide your Identity Provider's details. Ensure the certificate is in PEM format.

```json
{
  "enabled": true,
  "ssoUrl": "https://your-idp.com/sso",
  "entityId": "your-idp-entity-id",
  "certificate": "-----BEGIN CERTIFICATE-----\nMIIC...\n-----END CERTIFICATE-----"
}
```

--------------------------------

### Inline Form Scan: Document Ready

Source: https://docs.eleostech.com/docs/guide-document-scanning

This JSON indicates a document has been successfully processed and is ready for retrieval. It includes a 'download_url' for the document and its metadata.

```json
{
  "DOCUMENT-NUMBER": "10123679",
  "FORM-SCAN": {
    "status": "READY",
    "pages": [
      {
        "quality": 0.7982792854309082
      }
    ],
    "download_url": "https://example-download-link.com",
    "document_hub_url": "https://example-hub-link.com"
  },
  "TIME-FIELD": "2025-12-16T17:49:00+00:00",
  "Location": {
    "longitude": -82.79115223,
    "latitude": 34.70966265
  }
}
```

--------------------------------

### Configure SAML SSO

Source: https://docs.eleostech.com/docs/app-manager-saml-sso

Use the PUT /saml endpoint to configure your Identity Provider (IdP) details for SAML SSO. This includes enabling SSO, providing the IdP's SSO URL, Entity ID, and certificates.

```APIDOC
## PUT /saml

### Description
Configures SAML SSO settings for App Manager.

### Method
PUT

### Endpoint
/saml

### Parameters
#### Request Body
- **enabled** (boolean) - Required - Use `true` to enable SSO.
- **SSO URL** (string) - Required - The redirect/login URL from your IdP.
- **Entity ID** (string) - Required - Your IdP's unique identifier.
- **Certificates** (string) - Required - Certificate in PEM format for validating SAML responses.

### Request Example
```json
{
  "enabled": true,
  "SSO URL": "https://idp.example.com/sso",
  "Entity ID": "https://idp.example.com/entityid",
  "Certificates": "-----BEGIN CERTIFICATE-----\nMIID...\n-----END CERTIFICATE-----"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "SAML SSO configuration updated successfully."
}
```
```

--------------------------------

### User Authentication Response with Custom Settings

Source: https://docs.eleostech.com/docs/guide-settings

This JSON structure shows how custom settings are returned in the user authentication response. Ensure your backend accurately captures and returns these values.

```json
{
  "api_token": "example-ab33493",
  "custom": {
    "REMINDERS": true,
    "LOAD-HISTORY": "30"
  },
  "custom_settings_form_code": "MY-SETTINGS"
 }
```

--------------------------------

### Verify Session

Source: https://docs.eleostech.com/docs/guide-user-authentication

This endpoint is frequently used by the mobile app in the background to verify the validity of an existing API token and retrieve the latest user configuration data.

```APIDOC
## GET /authenticate/{token}

### Description
Verifies the validity of a provided API token and returns the user's current configuration data.

### Method
GET

### Endpoint
/authenticate/{token}

### Parameters
#### Path Parameters
- **token** (string) - Required - The API token to verify.

### Response
#### Success Response (200)
- **full_name** (string) - The full name of the user.
- **dashboard_code** or **dashboard** (string/object) - Configuration for the user's dashboard.
- **menu_code** or **menu** (string/object) - Configuration for the user's menu, must include a 'settings' item.
```

--------------------------------

### Update SSO Enabled Status

Source: https://docs.eleostech.com/docs/app-manager-saml-sso

Use the PUT /saml endpoint with the 'enabled' field to toggle SSO for your production environment.

```APIDOC
## PUT /saml (Update Enabled Status)

### Description
Enables or disables SAML SSO for the environment.

### Method
PUT

### Endpoint
/saml

### Parameters
#### Request Body
- **enabled** (boolean) - Required - Set to `true` to enforce SSO, `false` to disable.

### Request Example
```json
{
  "enabled": true
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "SAML SSO enabled status updated."
}
```
```

--------------------------------

### Configure HOS Contract Provider

Source: https://docs.eleostech.com/docs/guide-opencab-support

Enable the mobile app to fetch HOS information via the HOS contract provider from another mobile app. Requires specifying the contract and the provider's package name.

```json
{
  "opencab_configuration": {
    "providers": [
      {
        "contract": "org.opencabstandard.hos",
        "package": "com.example.acme.hos"
      }
    ]
  }
}
```

--------------------------------

### Configure Identity and HOS Contract Consumers

Source: https://docs.eleostech.com/docs/guide-opencab-support

Consume identity and HOS information from a single mobile app. This configuration allows the app to act as a consumer for multiple contracts from the same provider.

```json
{
  "opencab_configuration": {
    "providers": [
      {
        "contract": "org.opencabstandard.hos",
        "package": "com.example.acme.allinone"
      },
      {
        "contract": "org.opencabstandard.identity",
        "package": "com.example.acme.allinone"
      }
    ]
  }
}
```

--------------------------------

### Custom Settings Update

Source: https://docs.eleostech.com/docs/guide-user-authentication

This endpoint is used when a user modifies a custom setting within the app, allowing the app to save these changes to the web service while verifying the user's API token.

```APIDOC
## PUT /authenticate/{token}

### Description
Updates custom user settings and verifies the user's API token.

### Method
PUT

### Endpoint
/authenticate/{token}

### Parameters
#### Path Parameters
- **token** (string) - Required - The API token to verify.

### Request Body
- **setting_name** (string) - Required - The name of the custom setting to update.
- **setting_value** (any) - Required - The new value for the custom setting.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the settings were updated successfully.
```

--------------------------------

### Drive Axle API Key Authentication Header

Source: https://docs.eleostech.com/docs/guide-authentication-api-keys

Use this Authorization header for API calls if you are a Drive Axle Hub customer. Replace DRIVEAXLE_API_KEY with your key.

```http
Authorization: DriveAxleKey key=DRIVEAXLE_API_KEY
```

--------------------------------

### Handle OIDC Authentication Requests with curl

Source: https://docs.eleostech.com/docs/guide-mobile-sso-configuration

Use this curl command to send an OIDC authentication request from the mobile app to your authentication web service. Ensure all headers and data-urlencode parameters are correctly set.

```bash
curl --request POST https://your-auth-endpoint.example.com/authenticate \
-H "Eleos-Platform-Key: abcdef1234567890" \
-H "Eleos-Mobile-App-Platform: android" \
-H "Eleos-Mobile-App-Version: 1.61" \
-H "x-forwarded-for: 203.0.113.17" \
-H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "is_team_driver_login=false" \
--data-urlencode "oidc_idp_code=AZURE" \
--data-urlencode "oidc_nonce=s8TrnO3U4kQxtZmuD7wXs" \
--data-urlencode "oidc_id_token=eyJhbGciOi...UzI1NiIsInR5cCI6IkpXVCJ9..." \
--data-urlencode "oidc_access_token=eyJz93a...k4laUWw" \
--data-urlencode "oidc_expires_in=3600" \
--data-urlencode "oidc_refresh_token=0.ARcAq2...eAzQ"
```

--------------------------------

### Configure Geotab Telematics in User Authentication

Source: https://docs.eleostech.com/docs/guide-eld-integrations

When returning the `telematics` object in the User Authentication API, include `provider` set to `geotab-drive` and `hours_of_service_rules` for HOS compliance.

```json
{
  "api_token": "ddb56eb8-1b39-11e5-9c63-f9bd05003d3f",
  "full_name": "John Doe",
  "telematics": {
    "provider": "geotab-drive",
    "hours_of_service_rules": "AmericaShortHaul8DayNo34h"
  }
}
```

--------------------------------

### Eleos API Key Authentication Header

Source: https://docs.eleostech.com/docs/guide-authentication-api-keys

Include this Authorization header in HTTP requests to authenticate with the Eleos API. Replace API_KEY with your active key.

```http
Authorization: Key key=API_KEY
```
Tokens:
Raw