Kyocera

Kyocera multifunction devices are integrated with OptimiDoc through a dedicated REST API provided by the KyoceraTerminal application running on the device. The integration supports full terminal functionality, device authentication, native scanning, and print release. This page describes how the integration works under the hood, the supported models and features, and known limitations.

Kyocera is an embedded-terminal vendor: OptimiDoc installs a web terminal on the device panel, can lock the panel behind authentication, releases held jobs, and can drive the device's native scanner.

Integration Method

OptimiDoc integrates with Kyocera devices via a REST API served by the KyoceraTerminal application on port 8080 (HTTP). Configuration is pushed by posting a JSON payload to the /KyoceraTerminal/Conf endpoint, which registers the OptimiDoc server URL, the SSO flag, the interface language, the server context, and the terminal dispatch routes. The Legacy layout is served from /mfp; the web layouts are served from /terminal.

How the Integration Works

1. Installation

Installing OptimiDoc onto a Kyocera device posts the terminal configuration to the KyoceraTerminal application: the server URL, whether Single Sign-On is used, the language, the server context (device IP), and the authentication/SSO dispatch routes. No separate device administrator credentials are required — the KyoceraTerminal application manages the on-device configuration. OptimiDoc verifies the configuration by reading it back from the device.

2. Authentication

Users authenticate at the panel with a card, PIN, or login/password when Device Authentication is enabled; Single Sign-On is used when it is disabled (see methods below).

3. Native scan

Kyocera performs scanning on the device itself. OptimiDoc posts the scan parameters to /KyoceraTerminal/Scan, the device runs the scan, and OptimiDoc polls /KyoceraTerminal/Scan/{scanId} for progress until the job completes.

4. Accounting

Copy accounting requires Device Authentication to be enabled (accountingRequiresDeviceAuth). Without device authentication, the device cannot attribute walk-up copies to a user.

5. Remote login / uninstall

Kyocera does not support remote login or logout from the server side. The uninstall action reports success but does not make an active de-registration call to the device — the KyoceraTerminal application configuration is managed on the device itself.

Touch responsiveness (26.07): The Kyocera terminal received a touch-handling fix (ODT-1161). The web terminal now uses a dedicated touch-click handler that de-duplicates overlapping touch and click events, applies a small movement threshold to distinguish a tap from a scroll, and ignores the synthetic click that follows a touch — so taps on the Kyocera panel register reliably without double-firing or being missed.

Supported Models

OptimiDoc supports Kyocera devices with the HyPAS (Hybrid Platform for Advanced Solutions) application framework:

• Kyocera TASKalfa series

• Kyocera ECOSYS series (models with HyPAS support)

Supported Features

Native Scan Support

Kyocera is one of the vendors that supports native scanning directly from the device panel via the /KyoceraTerminal/Scan endpoint. The following scan parameters are configurable:

Scan jobs are monitored in real time via the /KyoceraTerminal/Scan/{scanId} polling endpoint.

Authentication Methods

The authentication methods offered for a Kyocera device depend on whether Device Authentication is enabled:

Kyocera specifics: Single Sign-On is available only when Device Authentication is disabled (ssoOnlyWithoutDeviceAuth), and the User List method is not offered for Kyocera. Kyocera does not support External Authentication or the combined Card and PIN / Card and Login and Password methods.

Terminal Features

Kyocera devices support the full OptimiDoc web terminal with the following options:

• Landing Page configuration

• Localisation settings (language passed during installation)

• Terminal Layout selection (Legacy, Classic, Classic Large/Small Display, and Modern)

The terminal dispatch routes are configured separately for authentication and SSO modes.

Prerequisites

Before installing the OptimiDoc agent on a Kyocera device:

1. Ensure HyPAS support is available on the device model.

2. Install the KyoceraTerminal application on the device if not already present.

3. Verify port 8080 is accessible from the OptimiDoc server.

4. Configure SNMP for monitoring if required.

Known Limitations

• No remote login/logout — Kyocera devices do not support remote unlock or lock from the server side.

• External authentication is not available for Kyocera devices.

• Card and PIN / Card and Login combination methods are not supported.

• User List authentication method is not offered.

• Device login and password fields are not used for Kyocera (the KyoceraTerminal app does not require separate admin credentials).

• The uninstall action reports success but does not perform an active removal call on the device.

In Summary

Kyocera devices integrate through the KyoceraTerminal REST application on port 8080. OptimiDoc pushes the terminal configuration, drives the device's native scanner (with progress polling), and locks the panel with card/PIN/login methods when Device Authentication is enabled — otherwise Single Sign-On is used. Copy accounting requires Device Authentication. Remote login/logout are not supported. From 26.07 the Kyocera terminal has markedly improved touch responsiveness.

Related Articles

• Managing Devices

• Device Communication Failures

• Supported Devices