• Quick Reference Table
• Authentication
  • Auth Type
  • Authorization Base URL
  • Header Format
  • Token Lifecycle
  • Available Scopes
• Authentication Code Snippets
  • 1. Initiate Authorization (Browser Redirect)
  • 2. Exchange Authorization Code for Tokens
  • 3. Refresh Access Token
  • Base64 Encoding Helper
• API Endpoints
  • GET /sfapi/GetConfiguration/
  • GET /sfapi/GetPrinter/
  • GET /sfapi/GetPrinterProperties/
  • GET /sfapi/PrepareUpload/
  • PUT {{sasUri}} - File Upload
  • POST /sfapi/Print/
  • GET /sfapi/Status/
• Status Codes
• Error Codes
• Common Integration Patterns
  • Pattern 1: Upload and Print
  • Pattern 2: Print from URL
  • Pattern 3: Poll Job Status
• Supported File Types

Print API Integration Guide

For AI Agents: This document is available in raw Markdown format for easier parsing. Replace .html extension with .md to get the raw Markdown source.

Auto-generated RAW AGENT.md for AI-assisted and human development Auto-generated testing RAW AGENT.md for AI-assisted and human development

API Version: 2

Quick Reference Table

Base URL: https://printapi.ezeep.com/

Authentication

Auth Type

OAuth 2.0 with Bearer Token

ezeep Blue supports the following authorization flows:
- Authorization Code Flow - Recommended for secure server-side apps
- Authorization Code Flow with PKCE - For SPAs, mobile apps, desktop applications
- Device Authorization Flow (Pairing Code Grant) - For CLI tools, scripts, devices without browser - Resource Owner Password Credentials - Legacy, not recommended - Client Credentials - Server-to-server (UMP customers only)

Authorization Base URL

https://account.ezeep.com/

Header Format

API Requests (Bearer Token) Authorization: Bearer <access_token>

Token Requests (Basic Auth) Authorization: Basic <base64_encoded_client_credentials>

Encoding format: - Public client (no secret): base64("<client_id>:") - Confidential client: base64("<client_id>:<client_secret>")

Token Lifecycle

Important: With refresh token rotation enabled, each refresh token is single-use. Store the new refresh token from each response.

Available Scopes

Authentication Code Snippets

1. Initiate Authorization (Browser Redirect)

# Open in browser - user will authenticate and be redirected with authorization code
https://account.ezeep.com/oauth/authorize?response_type=code&client_id=<your_client_id>&redirect_uri=<your_redirect_uri>&scope=printing

2. Exchange Authorization Code for Tokens

curl -X POST "https://account.ezeep.com/oauth/access_token/" \
     --header "Authorization: Basic <base64_encoded_client_id>" \
     --header "Content-Type: application/x-www-form-urlencoded" \
     --data "grant_type=authorization_code" \
     --data "scope=printing" \
     --data "code=<authorization_code>" \
     --data "redirect_uri=<your_redirect_uri>"

Response:

{
  "access_token": "eyJ0eXAiO...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "printing",
  "refresh_token": "erliDdAb..."
}

3. Refresh Access Token

curl -X POST "https://account.ezeep.com/oauth/access_token/" \
     --header "Authorization: Basic <base64_encoded_client_id>" \
     --header "Content-Type: application/x-www-form-urlencoded" \
     --data "grant_type=refresh_token" \
     --data "scope=printing" \
     --data "refresh_token=<your_refresh_token>"

Base64 Encoding Helper

# Public client (no secret)
echo -n "<client_id>:" | base64

# Confidential client (with secret)
echo -n "<client_id>:<client_secret>" | base64

Note: The base64 encoded string length must be a multiple of 4. Pad with = if needed.

API Endpoints

GET /sfapi/GetConfiguration/

Retrieve details of the currently authenticated user and related system configuration parameters. Used to determine supported filetypes for printing.

Request:

curl -X GET "https://printapi.ezeep.com/sfapi/GetConfiguration/" \
     --header "Authorization: Bearer <access_token>"

Response:

{
  "Drivers": {
    "PrinterDynamic": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
    "PrinterStatic": "f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3"
  },
  "Folders": [
    {
      "export": "",
      "id": 1,
      "op": 3
    }
  ],
  "SFForms": {
    "$Count": 0
  },
  "Shell": [],
  "System": {
    "BW": 0,
    "CONNECT": ":4001",
    "CONNECTEX": ":4001",
    "DocProvUplInterval": 60,
    "FILEEXT": "bmp;csv;doc;docm;docx;dot;dotm;dotx;eml;gif;htm;html;jpeg;jpg;log;mht;mhtml;odf;odg;odm;odp;odt;otg;oth;otp;ott;pdf;png;pot;potm;potx;pps;ppsx;ppt;pptm;pptx;rtf;scp;sda;sdd;sds;sdw;sgl;smf;sti;stw;sxd;sxg;sxi;sxm;sxw;tif;tiff;tpf;txt;vor;wtx;xls;xlsb;xlsm;xlsx;xlt;xltm;xltx;xml;xps;",
    "HOST": "https://vm-example-host:443",
    "HOSTEX": "https://vm-example-host:443",
    "MaxLocalPreviewFileSize": 16777216
  }
}

Response Fields:

GET /sfapi/GetPrinter/

Returns a list of printers available to the authenticated user.

Request:

curl -X GET "https://printapi.ezeep.com/sfapi/GetPrinter/" \
     --header "Authorization: Bearer <access_token>"

Response:

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "location": "Building A, Floor 2",
    "name": "printer 6"
  },
  {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "location": "",
    "name": "printer01"
  }
]

Response Fields:

GET /sfapi/GetPrinterProperties/

Returns detailed properties of a printer by ID or name.

Endpoints: GET /sfapi/GetPrinterProperties/ GET /sfapi/GetPrinterProperties/?id=<printer_uuid> GET /sfapi/GetPrinterProperties/?printer=<printer_name>

Parameters:

Note: If neither parameter is provided, returns properties for all available printers. Specify either printer or id, not both.

Request:

curl -X GET "https://printapi.ezeep.com/sfapi/GetPrinterProperties/?id=c3d4e5f6-a7b8-9012-cdef-123456789012" \
     --header "Authorization: Bearer <access_token>"

Response:

[{
    "Collate": true,
    "Color": false,
    "ColorSupported": true,
    "Driver": "TP Output Gateway",
    "DuplexMode": 2,
    "DuplexSupported": true,
    "Id": "d4e5f6a7-b8c9-0123-def0-234567890123",
    "Location": "",
    "MediaSupported": ["Auto", "Letter", "Legal", "Statement", "Executive", "A5", "B5", "A4", "Envelope Monarch", "Envelope No. 10 (COM10)", "Envelope DL", "Envelope C5", "Custom [Name Fixed]"],
    "MediaSupportedId": [0, 1, 5, 6, 7, 11, 13, 9, 37, 20, 27, 28, 256],
    "Name": "Canon UFR II Printer",
    "OrientationsSupported": ["portrait", "landscape"],
    "OrientationsSupportedId": [1, 2],
    "PaperFormats": [
        {"Id": 1, "Name": "Letter", "XRes": 2159, "YRes": 2794, "Default": false},
        {"Id": 5, "Name": "Legal", "XRes": 2159, "YRes": 3556, "Default": false},
        {"Id": 9, "Name": "A4", "XRes": 2100, "YRes": 2970, "Default": true},
        {"Id": 27, "Name": "Envelope DL2", "XRes": 1100, "YRes": 2200, "Default": false},
        {"Id": 28, "Name": "Envelope C5", "XRes": 1620, "YRes": 2290, "Default": false}
    ],
    "Default": {
        "Duplex": "duplex_simplex",
        "DuplexIndex": 1,
        "Color": "color",
        "Orientation": null,
        "OrientationIndex": null,
        "Resolution": "600",
        "Paper": "A4",
        "PaperId": 9,
        "Tray": "Multi-Purpose Feeder",
        "TrayIndex": 284
    },
    "Resolutions": ["Auto", "600"],
    "TPUID": 2,
    "Trays": [
        {"Index": 284, "Name": "Multi-Purpose Feeder", "Default": true},
        {"Index": 285, "Name": "Manual Paper", "Default": false},
        {"Index": 286, "Name": "Envelope Feeder", "Default": false}
    ]
}]

Response Fields:

Reference: ezeep follows Microsoft’s DEVMODE for printer properties. See DEVMODE specification.

GET /sfapi/PrepareUpload/

Prepares a file upload by generating a file ID and Azure SAS URI.

Request:

curl -X GET "https://printapi.ezeep.com/sfapi/PrepareUpload/" \
     --header "Authorization: Bearer <access_token>"

Response:

{
  "fileid": "ERI_e1f2a3b4-c5d6-7890-abcd-ef0123456789",
  "sasUri": "https://examplestore.blob.core.windows.net/userstorage/ERI_e1f2a3b4-c5d6-7890-abcd-ef0123456789?sv=2018-03-28&sr=b&sig=ExAmPlEsIgNaTuReStRiNg1234567890ABCDEF%3D&se=2024-01-01T12%3A00%3A00Z&sp=wl"
}

Response Fields:

PUT {{sasUri}} - File Upload

Uploads a file to Azure Blob Storage using the SAS URI from PrepareUpload.

Request:

curl -X PUT "<sasUri>" \
     --header "x-ms-blob-type: BlockBlob" \
     --header "Content-Type: multipart/form-data" \
     -F "file=@/path/to/your/file.pdf"

Headers:

Response: - HTTP 201 Created - File uploaded successfully (empty response body)

POST /sfapi/Print/

Prints an uploaded file or a file referenced by URL.

Request:

curl -X POST "https://printapi.ezeep.com/sfapi/Print/" \
     --header "Content-Type: application/json" \
     --header "Authorization: Bearer <access_token>" \
     --data '{
         "fileid": "<fileid>",
         "printerid": "<printerid>",
         "type": "pdf"
     }'

Parameters (Uploaded File):

Parameters (URL-Referenced File):

Example Request (URL-Referenced File):

curl -X POST "https://printapi.ezeep.com/sfapi/Print/" \
     --header "Content-Type: application/json" \
     --header "Authorization: Bearer <access_token>" \
     --data '{
         "fileurl": "https://example.com/document.pdf",
         "printerid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
         "type": "pdf",
         "properties": {"OrientationsSupported": "landscape", "MediaSupported": "Letter"}
     }'

Response (Success):

{
  "jobid": "ezprnds-d000001:Example_Printer#1234567890:1"
}

Response (File Still Uploading - HTTP 412):

{
  "fileid": "ERI_e1f2a3b4-c5d6-7890-abcd-ef0123456789",
  "sasUri": ""
}

Note: For large files referenced by URL, you may receive HTTP 412. Use the returned fileid with the standard print endpoint to retry.

GET /sfapi/Status/

Retrieves the current status of a print job.

Request:

curl -X GET "https://printapi.ezeep.com/sfapi/Status/?id=<jobid>" \
     --header "Authorization: Bearer <access_token>"

Parameters:

Response:

{
  "jobpagesprinted": 0,
  "jobpagestotal": 1,
  "jobposition": 1,
  "jobstatus": 129,
  "jobstatusstring": "PRINTING|RETAINED|"
}

Response Fields:

Status Codes

Error Codes

ezeep uses Microsoft error codes represented as integers. See https://learn.microsoft.com/en-us/windows/win32/debug/system-error-codes for a comprehensive list.

Common Integration Patterns

Pattern 1: Upload and Print

# 1. Prepare upload
UPLOAD_RESPONSE=$(curl -s -X GET "https://printapi.ezeep.com/sfapi/PrepareUpload/" \
     --header "Authorization: Bearer $ACCESS_TOKEN")

FILEID=$(echo $UPLOAD_RESPONSE | jq -r '.fileid')
SASURI=$(echo $UPLOAD_RESPONSE | jq -r '.sasUri')

# 2. Upload file
curl -X PUT "$SASURI" \
     --header "x-ms-blob-type: BlockBlob" \
     --header "Content-Type: multipart/form-data" \
     -F "file=@document.pdf"

# 3. Print
curl -X POST "https://printapi.ezeep.com/sfapi/Print/" \
     --header "Content-Type: application/json" \
     --header "Authorization: Bearer $ACCESS_TOKEN" \
     --data "{\"fileid\":\"$FILEID\",\"printerid\":\"$PRINTER_ID\",\"type\":\"pdf\"}"

Pattern 2: Print from URL

curl -X POST "https://printapi.ezeep.com/sfapi/Print/" \
     --header "Content-Type: application/json" \
     --header "Authorization: Bearer $ACCESS_TOKEN" \
     --data '{
         "fileurl": "https://public-url.com/document.pdf",
         "printerid": "'"$PRINTER_ID"'",
         "type": "pdf"
     }'

Pattern 3: Poll Job Status

while true; do
    STATUS=$(curl -s -X GET "https://printapi.ezeep.com/sfapi/Status/?id=$JOB_ID" \
         --header "Authorization: Bearer $ACCESS_TOKEN")

    STATUS_CODE=$(echo $STATUS | jq -r '.jobstatus')

    case $STATUS_CODE in
        0) echo "Print completed successfully"; break ;;
        129|1246) echo "Printing in progress..."; sleep 2 ;;
        *) echo "Error: $STATUS_CODE"; break ;;
    esac
done

Supported File Types

The following file extensions are supported for printing (retrieved via GetConfiguration):

Documents: doc, docm, docx, dot, dotm, dotx, odf, odg, odm, odp, odt, otg, oth, otp, ott, pdf, rtf, txt, xps

Spreadsheets: csv, xls, xlsb, xlsm, xlsx, xlt, xltm, xltx

Presentations: pot, potm, potx, pps, ppsx, ppt, pptm, pptx, sda, sdd, sds, sdw

Images: bmp, gif, jpeg, jpg, png, tif, tiff

Web/Email: eml, htm, html, mht, mhtml, xml

Other: log, scp, sgl, smf, sti, stw, sxd, sxg, sxi, sxm, sxw, tpf, vor, wtx