Canon

Canon multifunction devices are integrated with OptimiDoc through a custom REST API installed directly on the device. OptimiDoc supports Canon Generation 3 and newer imageRUNNER ADVANCE devices, providing full terminal, authentication, and print-release capabilities. This page describes how the integration works under the hood, the supported models and features, and known limitations.

Canon is an embedded-terminal vendor: OptimiDoc installs a web terminal and an authentication module on the device, can lock the panel behind authentication, and releases held jobs. Canon jobs are accounted through Canon's page-description/accounting stream (CDCA).

Integration Method

OptimiDoc integrates with Canon devices via a custom REST API reachable on port 8000 (HTTP) or 8443 (HTTPS). Installation authenticates to the device's administration interface and configures both the OptimiDoc authentication module and the terminal application endpoint.

OptimiDoc distinguishes between Gen2 and Gen3+ Canon devices. Gen3 and newer devices are fully supported with automated installation; Gen2 devices may require manual configuration of the terminal URL.

How the Integration Works

1. Installation

When you install OptimiDoc onto a Canon device, OptimiDoc:

1. Logs in to the device REST API with the device administrator credentials (default Administrator / 7654321).

2. If Device Authentication is enabled, posts the OptimiDoc authentication configuration — server host, port and context, the authentication method, the card-assignment method, and the print-all setting — and verifies it was applied.

3. Registers the OptimiDoc terminal on the device's application endpoint (a fixed UUID endpoint), passing the terminal home-page URL. The URL points at /mfp for the Legacy layout or /terminal for the web layouts.

4. Detects Gen2 devices: if the terminal endpoint returns Not Found, OptimiDoc logs a warning that manual intervention is required (Gen2 devices do not accept automated terminal registration).

If the terminal configuration fails, switching the device's SSL preference and retrying often resolves it.

2. Authentication

Users authenticate at the panel with a card, PIN, or login/password. Canon uses device-level authentication only — there is no Single Sign-On. External Authentication is available when Device Authentication is enabled.

3. Job accounting (CDCA)

Canon print jobs are described using CDCA (Canon's page-description/charge-accounting stream). OptimiDoc parses this stream to count pages and detect colour for accounting, and can rewrite it to enforce print options such as monochrome, duplex, copy count, and finishing before the job reaches the device. Copy accounting at the device requires Device Authentication to be enabled (accountingRequiresDeviceAuth).

4. Remote login (logout not supported)

Canon supports remote login from the OptimiDoc web/mobile app via the device's /OptimiDocUnlock endpoint. Remote logout is not supported.

5. Uninstallation

Remote uninstall is not supported through the API. To remove OptimiDoc from a Canon device, manual intervention on the device is required.

Supported Models

OptimiDoc supports Canon imageRUNNER ADVANCE series devices with the MEAP (Multifunctional Embedded Application Platform) framework:

• imageRUNNER ADVANCE Gen3 and newer (recommended)

• imageRUNNER ADVANCE Gen2 (limited — manual terminal configuration may be required)

• imageRUNNER ADVANCE DX series

Supported Features

Authentication Methods

Canon devices support device-level authentication only. Single Sign-On and User List are not available; External Authentication is available when Device Authentication is enabled.

The device administrator credentials (login and password) are used to authenticate OptimiDoc's connection to the Canon REST API. Default credentials are Administrator / 7654321.

Terminal Features

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

• Landing Page configuration

• Localisation settings

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

The terminal URL is registered on the device via a UUID-based endpoint during installation. The Legacy layout is served from /mfp; the web layouts are served from /terminal.

Prerequisites

Before installing the OptimiDoc agent on a Canon device:

1. Ensure the device is Gen3 or newer. Gen2 devices have limited automated installation support.

2. Note the device admin credentials. Default credentials are Administrator / 7654321, but these may have been changed.

3. Choose HTTP or HTTPS. Port 8000 is used for HTTP, port 8443 for HTTPS. Ensure the chosen port is accessible from the OptimiDoc server.

4. Enable Device Authentication if copy accounting is required — Canon copy accounting only works when Device Authentication is on.

5. Configure SNMP for monitoring if required.

Known Limitations

• Gen2 devices may not support automated terminal registration. The terminal URL may need to be configured manually on the device.

• Remote uninstall is not supported via the API. To remove OptimiDoc from a Canon device, manual intervention on the device is required.

• Remote logout is not supported (remote login is).

• SSL configuration may need to be toggled if the terminal configuration fails. Try switching the SSL preference if installation reports an error.

• Single Sign-On is not available for Canon devices.

• Native scan is not supported through the Canon integration layer.

• Copy accounting requires Device Authentication to be enabled.

In Summary

Canon devices integrate through a custom REST API on port 8000/8443. OptimiDoc logs in with the device admin credentials, configures device authentication and the terminal endpoint, and detects Gen2 devices that need manual setup. Authentication is device-level only (no SSO), with External Authentication available when Device Authentication is on. Jobs are accounted through the Canon CDCA stream, which OptimiDoc also uses to enforce print options. Remote login is supported; remote logout and remote uninstall are not.

Related Articles

• Managing Devices

• Device Communication Failures

• Supported Devices