> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/commons/dealer.md). # 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](/docs/navixy-api/user-api/resources/commons/history.md) list operations, `report.max_time_span` caps [report generation](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-generate), and `stats.max_time_span` and `stats.max_allowed_trackers` cap the [stats operations](/docs/navixy-api/user-api/resources/tracking/tracker/stats/stats_mileage.md). Date and time values follow the [platform formats](/docs/navixy-api/general/api-conventions.md#date-time-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 > 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. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Account and platform","description":"Platform-level resources shared across the account, such as the plugins that change how other calls behave."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[],"paths":{"/dealer/get_ui_config":{"post":{"tags":["Account and platform"],"summary":"Get dealer UI config","description":"Return the branding and interface configuration of a dealer: maps, default map position, currency, logos, wallpapers, locale, and the demo account credentials.\n\n**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.","operationId":"dealerGetUiConfig","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"The dealer's monitoring interface domain, such as `panel.navixy.com`."},"hash":{"type":"string","description":"A user session hash, used instead of `domain` to identify the dealer when a session exists."}}}}}},"responses":{"200":{"description":"The dealer configuration","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"dealer":{"type":"object","description":"Identity of the dealer.","properties":{"id":{"type":"integer","description":"Dealer ID."},"ui_domain":{"type":"string","description":"Domain of the dealer monitoring interface."},"company_url":{"type":"string","description":"The company website."}}},"settings":{"$ref":"#/components/schemas/DealerUiSettings"},"demo_ends":{"type":["string","null"],"description":"When the demo for this dealer ends. Null when the dealer is not on a trial plan."},"allow_branding":{"type":"boolean","description":"True when the dealer may replace the platform branding on the web interface."},"premium_gis":{"type":"boolean","description":"True when the dealer has the Premium GIS package."},"features":{"type":"array","description":"Features allowed for this dealer. See the dealer features table on the page.","items":{"type":"string","enum":["branding_web","branding_mobile","subpaas","navixy_label"]}},"platform":{"type":"object","description":"Global platform limits and capabilities. Several other operations refer to these.","properties":{"iso_datetime_support":{"type":"boolean","description":"True when the platform supports the ISO 8601 date and time format."},"history.max_limit":{"type":"integer","description":"Maximum limit for the history list operations, and their default."},"report.max_time_span":{"type":"string","description":"Maximum time span for report generation, as an ISO 8601 duration."},"stats.max_allowed_trackers":{"type":"integer","description":"Maximum number of trackers for the stats operations."},"stats.max_time_span":{"type":"string","description":"Maximum time span for the stats operations, as an ISO 8601 duration."},"file_storage.hard_max_file_size":{"type":"integer","description":"Hard maximum file size in bytes for uploads to file storage.","format":"int64"},"form.max_fields_count":{"type":"integer","description":"Maximum number of fields per form."},"form.file_field.max_file_size":{"type":"integer","description":"Maximum size in bytes of a file attached to a form field.","format":"int64"},"form.file_field.max_files_per_field":{"type":"integer","description":"Maximum number of files per form field."},"form.file_field.max_count":{"type":"integer","description":"Maximum number of file fields per form."}},"additionalProperties":true},"redirect_to":{"type":"string","description":"Where the caller should be sent instead, when the dealer is configured to redirect. Absent when there is no redirect."}}}}}},"400":{"description":"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.","$ref":"#/components/responses/ResponseError"},"404":{"description":"Error 12: no dealer was found for the given domain or hash. Error 201: not found in the database.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}},"components":{"schemas":{"DealerUiSettings":{"type":"object","description":"How a dealer monitoring interface should present itself. Returned to an unauthenticated caller, so it carries branding and defaults but no account data.","properties":{"domain":{"type":"string","description":"Domain of the interface."},"service_title":{"type":"string","description":"Name of the service, shown in the interface."},"locale":{"type":"string","description":"Default locale."},"demo_login":{"type":"string","description":"Login for the demo account."},"demo_password":{"type":"string","description":"Password for the demo account."},"maps":{"type":"array","description":"Map types available to this dealer users.","items":{"type":"string"}},"default_map":{"type":"object","description":"Which map to show, and where, before the user has chosen.","properties":{"type":{"type":"string","description":"Default map type."},"location":{"type":"object","description":"Where the map is centred by default.","properties":{"lat":{"type":"number","description":"Latitude."},"lng":{"type":"number","description":"Longitude."}}},"zoom":{"type":"integer","description":"Default zoom level."}}},"currency":{"type":"string","description":"The dealer currency, as an ISO 4217 code."},"payment_link":{"type":["string","null"],"description":"Link a user can follow to top up their account. Depends on the PaaS, and may be null or empty."},"promo_url":{"type":"string","description":"Customizable About company URL."},"google_client_id":{"type":["string","null"],"description":"Client ID for working with the Google API, or null."},"favicon":{"type":["string","null"],"description":"Path or URL to the interface favicon."},"logo":{"type":["string","null"],"description":"Path or URL to the logo."},"app_logo":{"type":["string","null"],"description":"Path or URL to the mobile app logo."},"login_wallpaper":{"type":["string","null"],"description":"Path or URL to the login page wallpaper."},"desktop_wallpaper":{"type":["string","null"],"description":"Path to the interface wallpaper, or null."},"monitoring_logo":{"type":["string","null"],"description":"Path to the monitoring page logo, or null."},"login_footer":{"type":"string","description":"Footer included on the login page. HTML special characters are escaped as entities."},"allow_registration":{"type":"boolean","description":"True when self-registration is available to this dealer users."},"show_mobile_apps":{"type":"boolean","description":"True when mobile applications are offered to this dealer users."},"show_call_notifications":{"type":"boolean","description":"True when call notifications are available."},"geocoder":{"type":"string","description":"Default geocoder."},"route_provider":{"type":"string","description":"Default route provider."},"measurement_system":{"type":"string","description":"Measurement system to present values in."},"display_model_features_link":{"type":"boolean","description":"True to show a link to squaregps.com in the device model information."},"color_theme":{"type":"string","description":"Colour theme code, or an empty string for the default theme."},"app_color_theme":{"type":"string","description":"Mobile app colour theme code, or an empty string for the default theme."},"privacy_policy_link":{"type":["string","null"],"description":"Privacy policy link. May be null or empty."},"tos":{"type":["string","null"],"description":"Terms of service text. May be null or empty."},"tracker_model_filter":{"type":"object","description":"Which device models may be registered.","properties":{"exclusion":{"type":"boolean","description":"When true, the models in `values` are excluded rather than being the only ones allowed."},"values":{"type":"array","description":"Model names the filter applies to. An empty list means every model is available.","items":{"type":"string"}}}},"internal":{"type":"object","description":"Additional options.","properties":{"light_registration":{"type":"boolean","description":"When true, use the simplified registration flow with a demo tracker."},"demo_tracker_source_id":{"type":"integer","description":"ID of the tracker created by light registration."},"demo_tracker_label":{"type":"string","description":"Label of the tracker created by light registration."},"no_register_commands":{"type":"boolean","description":"When true, do not send configuration commands to devices on activation."}}}},"additionalProperties":true}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}}} ``` #### Errors These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#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. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://navixy.com/docs/navixy-api/user-api/resources/commons/dealer.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.