HP Embedded Capture Betriebsanweisung

HP Embedded Capture (HP EC)API Reference GuideVersion 1.3.0

◦Execute any API call with basic authentication using admin user/password.or◦From the administrator console, edit the admin password in all changed de

3 Compatible API3.1 Graph and job services3.1.1 Put jobTable 3-1 Put a new job?api=jobs&method=putPOST Description Uploads new scan job (simple w

Figure 3-1 Put job, Request payload exampleDestination examplesA scan job can be assigned any of the following destinations:6 Chapter 3 Compatible

●LocalThe Local destination saves scanned documents to the device hard drive. They are not sent out of thedevice, and can only be recovered through an

●Error response example:As an example, when two jobs with the same navigation filters “label A” and “label B” are uploaded, both willbe visible under

Table 3-2 View job (continued)Payload IN -OUT If 200, XML response with job details.If 400, XML response with error code.Response Code 200 OK — succe

Figure 3-2 View job, success response example3.1.3 Delete jobTable 3-3 Delete job?api=jobs&method=delete&jobId={jobId}10 Chapter 3 Compati

Table 3-3 Delete job (continued)GET Description Removes a job by changing its status to “cancelled.” Deleted jobs will still appear in an APIview req

Table 3-4 Get files (continued)OUT If 200, XML response with files or xml with direct download links.If 400, XML response with error code.Response Co

Table 3-5 Set purge settings (continued)Payload IN XML Configuration parametersOUT If 200, XML response with code 0If 400, XML response with error co

© Copyright 2014 Hewlett-PackardDevelopment Company, L.P.Microsoft, Windows, and Windows NT are U.S.registered trademarks of MicrosoftCorporation.June

Table 3-6 Get device info (continued)◦Device Family (“FutureSmart” or “Non-FutureSmart”)◦Hostname◦Tray width (mm)◦Tray height (mm)Payload IN —OUT If

Table 3-7 Get device status (continued)Response Code 200 OK — success401 Unauthorized access — if basic authentication fails500 Internal Server Error

Table 3-9 Get solution info (continued)Payload IN —OUT If 200, XML response with solution info.Response Code 200 OK — success401 Unauthorized access

Figure 3-10 Get solution status, Response exampleTable 3-11 Navigation status possible valuesCode Meaning0 Unknown1 Navigating2 Scanning3 Processing

Figure 3-11 Wake up, success response exampleTable 3-13 Device Status possible valuesCode Meaning Explanation1 OK Device is awake0 KO Device is not

Figure 3-12 Cancel scan, Success response example3.2.7 Reset SolutionTable 3-15 Reset Solution?api=config&method=resetSolutionGET Description Th

Figure 3-13 Reset solution, success response example3.3 Extensibility services3.3.1 Set buttonTable 3-16 Set button?api=extensibility&method=set

Figure 3-14 Extensibility services, Set button — request payload exampleFigure 3-15 Extensibility services, Set button — success response example3.3

Table 3-17 Remove button (continued)500 Internal Server Error – if too many requests are active. Retryrecommended.Schema Request —Response?api=common

Table 3-18 Set API Password (continued)Schema Request?api=accessibility&schema=setApiPasswordResponse?api=common&rschema=defaultFigure 3-17

Table of contents1 API Introduction ...

Figure 3-19 Block Embedded Capture UI, success response example3.4.3 Unblock Embedded Capture UITable 3-20 Unblock device?api=accessibility&meth

3.5 Logging services3.5.1 Enable logTable 3-21 Enable log?api=logging&method=enablePOST Description Method that enables the Logging Service durin

3.5.2 Get logTable 3-22 Get log?api=logging&method=getGET Description Method that retrieves the logs of Embedded Capture. The logs arereturned in

4 Advanced APIThe Advanced mode API is only available on FutureSmart devices.To distinguish between device models when using Advanced API calls in a m

Figure 4-1 Set graph, request payload example28 Chapter 4 Advanced API

Section 4.1 Graph and job services 29

30 Chapter 4 Advanced API

Section 4.1 Graph and job services 31

Figure 4-2 Success response exampleNOTE: See section Appendix I to check the settings possible and default values.4.1.2 Append graphTable 4-2 Append

Table 4-2 Append graph (continued)411 Length required – if content length is not or is badly specified500 Internal Server Error – if too many request

3.4.2 Block Embedded Capture UI ... 233.4.3 Unblock

Figure 4-4 View graph, success response example4.1.4 Clear graphTable 4-4 Clear graph?api=graph&method=clear&includeScheduled={boolean}GET D

Table 4-4 Clear graph (continued)400 Bad requestError code -2: Invalid request parametersError code -10: Device is busyError code -12: Unexpected err

Table 4-5 Modify node (continued)411 Length required – if content length is not or is badly specified500 Internal Server Error – if too many requests

Table 4-6 Delete node (continued)Error code -5: Id not corresponding to a valid nodeError code -10: Device is busy (silent mode)Error code -12: Unexp

5 Appendix I: API settings referenceThe following completes the information provided in the API XSD documents that are more related to thestructure an

NAME POSSIBLE VALUESType “jpg”, “pdf”, “tiff”, “mtiff”, “xps”Color “color”, “bw”, “grayscale”Resolution “75”, “150”, “200”, “300”, “400”, “600”Duplex

5.5 Destinations●Destination tag: obligatory●Type attribute: mandatory●Metadata attribute: optional (default value = false)Destination email:NAME TYPE

6 Appendix II: Error codesThe following table provides a summary of all possible API error codes returned when something does notwork as expected, or

List of tablesTable 3-1 Put a new job ...

List of figuresFigure 3-1 Put job, Request payload example ...

1 API IntroductionThe HP Embedded Capture (HP EC) Application Programming Interface (API) enables client applicationsintegration that interacts with M

NOTE: Changes to the transport protocol — to use or stop using SSL — should be done during deviceconfiguration (Embedded webserver). See the HP Embedd

2 API securityTo avoid unauthorized access, all API calls can be password protected by the administrator. Protecting theAPI guarantees that the MFP ca