CLI Reference Guide

1 API Introduction
The HP Embedded Capture (HP EC) Application Programming Interface (API) enables client applications
integration that interacts with MFP devices to manage workflow and remote document capture. API services
are provided as part of the professional services agreement for HP Embedded Capture 1.1 or higher versions.
1.1 Basic and Advanced modes
The Embedded Capture solution works with a set of FutureSmart and non-FutureSmart MFP devices.
FutureSmart offers an advanced set of functionalities that can take advantage of all the power of Embedded
Capture. Non-FutureSmart devices cover a subset of those functionalities (basic) with standard document
capture capabilities like Scan, metadata (with restrictions), and certain navigation levels (2) that cover the
majority of the use cases.
The API is divided into two categories: Basic and Advanced
1.1.1 Basic API
The Basic API is compatible with the entire fleet (FutureSmart and non-FutureSmart devices). API integrators
do not need to distinguish between device models. The same API calls and URLs are available on both
models.
1.1.2 Advanced API
The Advanced API extends the complexity and flexibility of workflows managed on a device, offering extra
functionalities in addition to what the Basic API provides.
1.2 Accessing the API on a device (%API_URL%)
The Embedded Capture API is exposed throughout the MFP in specific URLs by using SSL (recommended).
Although it is possible to use the API in http mode without encryption, this is NOT recommended. Deployment
of workflows with associated parameters (including passwords) will be transferred in plain text over the
network, and may be exposed to unauthorized access.
Some API calls will send parameters by GET and others by POST. This is specified on each API definition table.
Section 1.1 Basic and Advanced modes 1