Dealer

The dealer's interface configuration and the platform-wide limits that constrain other operations.

A dealer is the reseller whose platform an account lives on. This operation returns the dealer's interface configuration, the branding features it has enabled, and the platform-wide limits that other operations enforce.

The platform block is the part integrations care about most, because it states limits that are otherwise only discoverable by hitting them: history.max_limit caps the history list operations, report.max_time_span caps report generation, and stats.max_time_span and stats.max_allowed_trackers cap the stats operations. Date and time values follow the platform formats.

Dealer features

Name	Description
branding_web	Allows custom logos, colour theme, domain, and favicon in the web interface.
branding_mobile	Allows a custom icon, logo, and colour theme in the mobile applications.
subpaas	Allows sub-dealers. Can be used only together with navixy_label.
navixy_label	Shows "Powered by Navixy" in the interface. Required for the subpaas feature.

API actions

API base path: /dealer.

---

Get dealer UI config

post

/dealer/get_ui_config

Return the branding and interface configuration of a dealer: maps, default map position, currency, logos, wallpapers, locale, and the demo account credentials.

No authentication is required. This is how a monitoring interface finds out how to present itself before anyone has logged in. Identify the dealer either by domain, or by hash when a user session already exists.

Body

domainstringOptional

The dealer's monitoring interface domain, such as panel.navixy.com.

hashstringOptional

A user session hash, used instead of domain to identify the dealer when a session exists.

Responses

200

The dealer configuration

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

demo_endsstring · nullableOptional

When the demo for this dealer ends. Null when the dealer is not on a trial plan.

allow_brandingbooleanOptional

True when the dealer may replace the platform branding on the web interface.

premium_gisbooleanOptional

True when the dealer has the Premium GIS package.

redirect_tostringOptional

Where the caller should be sent instead, when the dealer is configured to redirect. Absent when there is no redirect.

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

404

Error 12: no dealer was found for the given domain or hash. Error 201: not found in the database.

application/json

default

Error response object

application/json

post/dealer/get_ui_config

POST /v2/dealer/get_ui_config HTTP/1.1
Host: api.eu.navixy.com
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "domain": "text",
  "hash": "text"
}

{
  "success": true,
  "dealer": {
    "id": 1,
    "ui_domain": "text",
    "company_url": "text"
  },
  "settings": {
    "domain": "text",
    "service_title": "text",
    "locale": "text",
    "demo_login": "text",
    "demo_password": "text",
    "maps": [
      "text"
    ],
    "default_map": {
      "type": "text",
      "location": {
        "lat": 1,
        "lng": 1
      },
      "zoom": 1
    },
    "currency": "text",
    "payment_link": null,
    "promo_url": "text",
    "google_client_id": null,
    "favicon": null,
    "logo": null,
    "app_logo": null,
    "login_wallpaper": null,
    "desktop_wallpaper": null,
    "monitoring_logo": null,
    "login_footer": "text",
    "allow_registration": true,
    "show_mobile_apps": true,
    "show_call_notifications": true,
    "geocoder": "text",
    "route_provider": "text",
    "measurement_system": "text",
    "display_model_features_link": true,
    "color_theme": "text",
    "app_color_theme": "text",
    "privacy_policy_link": null,
    "tos": null,
    "tracker_model_filter": {
      "exclusion": true,
      "values": [
        "text"
      ]
    },
    "internal": {
      "light_registration": true,
      "demo_tracker_source_id": 1,
      "demo_tracker_label": "text",
      "no_register_commands": true
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "demo_ends": null,
  "allow_branding": true,
  "premium_gis": true,
  "features": [
    "branding_web"
  ],
  "platform": {
    "iso_datetime_support": true,
    "history.max_limit": 1,
    "report.max_time_span": "text",
    "stats.max_allowed_trackers": 1,
    "stats.max_time_span": "text",
    "file_storage.hard_max_file_size": 1,
    "form.max_fields_count": 1,
    "form.file_field.max_file_size": 1,
    "form.file_field.max_files_per_field": 1,
    "form.file_field.max_count": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "redirect_to": "text"
}

Errors

These errors come in addition to the general error codes:

• 12 - Dealer not found, when no matching dealer is in the database.

• 201 - Not found in the database, when the dealer has no interface settings data.