Generic HTTPS connector

Relevant Products

Generic HTTPS connector is available in BREEZE MFD PRO MFP

Use the Generic HTTPS connector to deliver scanned files to a specific HTTPS endpoint for custom post-processing. The endpoint must be able to handle the predefined request format.

Connector configuration

Endpoint URL – HTTPS endpoint URL where the scanned documents should be sent (for example, Azure function URL).
Request properties (optional) – properties in the name-value pair propagated to the Endpoint URL.

Each custom request property will be sent to the endpoint URL as a separate part in a single multipart/form-data request. The property name is automatically prepended with "custom_" prefix to avoid collisions with existing properties. For example, "MyProperty=1234" will be sent as "custom_MyProperty=1234" parameter.

Request

The scanned job files are sent all together in a single multipart/form-data request. The request also includes all scan parameters, which are added dynamically.

API documentation that your endpoint should implement

YML

openapi: 3.0.0
info:
description: This is an API for uploading scan jobs
version: "1.0.0"
title: API scan connector

paths:
  /api/scan:
    post:
      summary: Uploads and process scan job
      description: |
        Upload scan job (both data and metadata),        
      responses:
        '200':
          description: scan job processed successfully
        '400':
          description: 'error'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                username:
                  type: string
                  # all other connector-specified and user-defined variables goes here
                  # in the same way as username
                  # e.g:
                  # mailTo:
                  # type: string
                  # mailFrom:
                  # type: string
               filename:
                  # default is application/octet-stream, need to declare the type
                  # e.g. application/pdf or image/jpg
                  type: array
                  items:
                    type: string
                    format: binary
             encoding:
               filename: 
                  contentType: image/jpeg, image/tiff, applicaton/pdf 
                  style: form
                  explode: true

Example request

A request with one variable %userEmail% and one document. In a production environment, the request would contain all the scan metadata, all available user inputs, and all files. The boundary is randomly generated with each request.

TEXT

POST / HTTP/1.1
Connection: keep-alive
Content-Type: multipart/form-data; boundary=---------------------------123456789
Content-Length: 554

-----------------------------123456789
Content-Disposition: form-data; name="userEmail"

john.doe@company.com
-----------------------------123456789
Content-Disposition: form-data; name="file1"; filename="document.pdf"
Content-Type: text/plain

Content of document.pdf.

-----------------------------123456789

Example parameters that are added to the multipart/form-data request

Example of paramaters sent in the request

CODE

scanTime: 15-57-20-003,
workflowID: 3,
scanJobID: 89905361-d77c-45ae-a2d1-6179283dddb5,
userDepartment: ,
scanDate: 2023-10-17,
deviceDescription: Printer,
safeqHome: \opt,
userEmail: user@mail.com,
deviceID: 1,
userHome: ,
workflowName: My workflow,
userUsername: user@2,
userFullName:

In addition, any custom input variables set in the workflow, such as %faxNumber%, will be included in the request too.