• Requirements
• Starting
• Endpoints
• Base Url
  • 1. Redirects the user to the authorization Page
  • 2. Returns an authorization code as a URL parameter to the redirect URI
• Request access token
• Use refresh token
• Base URL
• Get Configuration
• Get Printer
• Get Printer Properties
• Prepare file upload
• File Upload
• Print an uploaded file
• Print a file referenced by URL
• Get Status
• Status Codes
• Error codes

About ezeep Blue

ezeep is the future of Printing. With ezeep, printing will become dramatically simpler and any device will be able to print on any printer. ezeep Blue combines the simplicity of ezeep with the stability, scalability and high printing speed of ThinPrint’s remote desktop solution.

Thanks to ezeep, organizations can simplify their administration and provide printing to their users with fewer requirements on their infrastructure. With a few clicks, they can manage access to their printers and monitor print activity. That leads to lower overall costs for printing.

ezeep’s API first approach ensures open interfaces that allow easy integrations with existing solutions for user and resource management, cost control, compliance monitoring and others to achieve maximum savings through automation. A continuously growing ecosystem of standard integrations by development partners benefits non-technical customers as well.

By lowering costs, removing technical requirements and providing the ability to share printers in a managed and secure way with anyone anywhere, ezeep ensures that printing becomes easy.

Introduction

ezeep Blue supports a Print API that enables 3rd Party developers to use the ezeep platform and fully integrate printers into their workflows. In this document you will go through a full print workflow and will learn to

• Connect a user account with the authorization code workflow
• Authenticate a user with access and refresh tokens
• Pick a cloud connected printer
• Create and upload a document
• Adjust settings for a print job
• Trigger a print job to an ezeep-connected printer
• Get information on the printjob status

Requirements

• ezeep Blue administrator account
• Your personal ezeep Client ID and Client Secret
• base64 encoded clientId
• Redirect Uri

To setup your ezeep administrator account and organization, sign up here

To receive your Client ID,Client Secret and provide your redirect URI(s) contact us at helpdesk@ezeep.com

For the full documentation on setting up your ezeep Blue account, check our web documentation

## Base 64 encoded id base_64_encoded_client_id Basic authentication scheme is used, meaning the Authorization header value is Basic followed by a space and the base64 encoded client_id followed by a colon : followed by your client secret For example: If your client id is g34ibgu2fhon and your client secret is jisow35ysdlalx35s2avnks43223jdhjsdk you need to base64-encode it as g34ibgu2fhon:jisow35ysdlalx35s2avnks43223jdhjsdk which results in ZzM0aWJndTJmaG9uOmppc293MzV5c2RsYWx4MzVzMmF2bmtzNDMyMjNqZGhqc2RrCg==. You can use a base64 encoding tool like this one.

Starting

The printing workflow requires you to

• authenticate the user
• get printers
• prepare an upload
• upload a file
• print

Endpoints

Base Url

https://account.ezeep.com

Authorize token end point

1. Redirects the user to the authorization Page

https://account.ezeep.com/oauth/authorize?response_type=code&client_id=<client_id>&redirect_uri=<redirect_uri>

2. Returns an authorization code as a URL parameter to the redirect URI

• <your redirect_uri>/?code=<authorization_code>

• myapp://callback?code=<authorization_code>

• The Authorization code is valid indefinitely but can only be used once

Required query parameters:

Request access token

Returns access token. It will be valid for 3600 seconds(1 hour) and after that duration you have to request new access token using the refresh token that you received in the access token response.

POST 'https://account.ezeep.com/oauth/access_token'

Example Request

curl  -X POST 'https://account.ezeep.com/oauth/access_token/' \
      -H "Authorization:Basic <base64_encodedId>"  \
      -d "{
           'grant_type':'authorization_code',
           'scope' :'printing',
           'code':'<authorization_code>'
           'redirect_uri' : '<registered redirect_uri>'
         }" 

Example Response

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

Use refresh token

You can use the refresh token once to generate a new access token and refresh token,it will also valid for 3600 seconds(1 hour).

curl -X POST 'https://account.ezeep.com/oauth/access_token/'

Example request:

curl -X POST 'https://account.ezeep.com/oauth/access_token/' \
     -H 'Authorization:Basic UkhFWlJmN2FmUUSnh0MDoNCg==' \
     -d "{
          'grant_type':'refresh_token',
          'scope':'printing'
          'refresh_token':'<refresh_token>'
        }"

Example Response

{
    "access_token": "eyJ0eXAiOiJ...",
    "token_type": "Bearer",
    "expires_in": 3600,
    "scope": "",
    "refresh_token": "vT5GTKk8..."
}

You will need to replace and store the new refresh token securely from the response for future usage.

Printing

To print using the ezeep print api first you will need to work through the Authentication process and have a valid access token. You can now use this token to work through the following steps of the printing process.

• Get printer
• Prepare an upload
• Upload a file
• Print

Base URL

https://printapi.ezeep.com/

Get Configuration

With this request, you can retreive details of the currently authenticated user and related system configuration parameters . It is used to determine which filetypes are supported for printing (System:FILEEXT)

Get https://printapi.ezeep.com/sfapi/GetConfiguration/

Example Request:

curl -X Get 'https://printapi.ezeep.com/sfapi/GetConfiguration/' \
     -H "Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhb...."

Example response:

The response contains a list of available printers

{
    "Drivers": {
        "PrinterDynamic": "0e651413e003e36de6781cfe227a9cc2",
        "PrinterStatic": "ee527381ab6ab5d4aba89f8ec2fd5d2c"
    },
    "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-mfkym5000000:443",
        "HOSTEX": "https://vm-mfkym5000000:443",
        "MaxLocalPreviewFileSize": 16777216,
      
    },
   
}...........

Get Printer

Requests a list of printers available to the user

  GET  https://printapi.ezeep.com/sfapi/GetPrinter/

Example Request:

The response contains a list of available printers:

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

Example Response:

[
  {
    "id": "2fd4f571-7c2e-4042-8fc5-1d736f532e88",
    "location": "Parallel Universe 2b-α-3187",
    "name": "printer 6"
  },
  {
    "id": "9620e656-b39b-49ba-a653-a3f168575ec2",
    "location": "",
    "name": "printer01"
  }
  
]

Get Printer Properties

Returns further properties of the printer by printer id.

 GET https://printapi.ezeep.com/sfapi/GetPrinterProperties/

Specify either printer_name or printer_id. ezeep is following Microsofts DEVMODE for printer properties. You can find a detailed specification here

Example Request:

curl -X GET \
     "https://printapi.ezeep.com/sfapi/GetPrinterProperties/?id=016bc036-2498-431e-84c6-14552639f515" \
     -H "Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9." 

Example response:

[
  {
    "Collate": true,
    "Color": false,
    "Driver": "",
    "DuplexMode": 0,
    "DuplexSupported": false,
    "Id": "9620e656-b39b-49ba-a653-a3f168575ec2",
    "Location": "",
    "MaxXExtent": 0,
    "MaxYExtent": 0,
    "Name": "printer01",
    "OrientationsSupported": [
      "portrait",
      "landscape"
    ],
    "OrientationsSupportedId": [
      1,
      2
    ]
  }
]

Prepare file upload

Uploads a file to print.

GET https://printapi.ezeep.com/sfapi/PrepareUpload/

Example request:

curl -X GET 'https://printapi.ezeep.com/sfapi/PrepareUpload/' \
     -H "Authorization:Bearer <access__token>" 

Example Response:

The response will include the file id of your new document as well as the sasURI which we will use for the upload later on:

{
  "fileid": "ERI_be20b4d1-d6b8-41ee-8ca8-580905b9b4ed",
  "sasUri": "https://rndsvcezp.blob.core.windows.net/userstorage/ERI_be20b4d1-d6b8-41ee-8ca8-580905b9b4ed?sv=2018-03-28&sr=b&sig=FxuLjL2Kids9Ww60dqQ6FlqscTTccKFBwk%2Ft0Tyf%2BM0%3D&se=2020-05-22T15%3A45%3A12Z&sp=wl"
}

File Upload

Uploads a file to print.

PUT {{sasURI}}

Example request:

curl -X PUT  \
      "https://rndsvcezp.blob.core.windows.net/userstorage/ERI_db66aea1-f702-4a0a-b2ee-37a7cdacd376 
       sv=2019-07-07&sr=b&sig=9y%2Fs5gOgVZgxI2ap634TnKQzilTmTcicCOOIWYVVnNs%3D&se=2021-02-08T23%3A06%3A52Z&sp=wl"
    -H "x-ms-blob-type: BlockBlob" \
    -H "Content-Type:multipart/form-data" \
    -F "file=test@C:/Users/User/Desktop/testfile.pdf"

If successful, you will receive an empty HTTP 201 (created) response.

Print an uploaded file

Prints a file that you have uploaded.

POST https://printapi.ezeep.com/sfapi/Print/

Parameters:

Example request:

The request parameters need to be sent in the body in JSON format.

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

Example Response:

{
  "jobid": "ezprnds-d000001:HP Un_tpcb_788_7863578#2031753094:4"
}

Print a file referenced by URL

Target documents’s URL must be public reachable and must contain all information needed to download the file (e.g. authorization information if needed).

Request and response are more or less the same as for Print an uploaded file. But the JSON attribute fileid is replaced by fileurl. Since the file is downloaded in background it’s not unlikely (depending on file’s size) that printing can’t start immediately. In this case you will receive HTTP 412 Precondition failed and the response provides you a fileid you can use for Print an uploaded file.

POST https://printapi.ezeep.com/sfapi/Print/

Parameters:

Example request:

curl -X "https://printapi.ezeep.com/sfapi/Print" \
     -H "Content-Type:application/json" \
     -H "Authorization:Bearer eyJ0eXAiOiJKV1..." \
     -d "{
         'fileurl':'https://file-examples-com.github.io/uploads/2017/10/file-sample_150kB.pdf','printerid':'016bc036-2498-431e-84c6-14552639f515',
         'type':'pdf'
        }"

Example Response if file has printed:

{
  "jobid": "ezprnds-d000001:HP Un_tpcb_788_7863578#2031753094:4"
}

Example response if file is still uploading (larger files):

{
  "fileid": "ERI_be20b4d1-d6b8-41ee-8ca8-580905b9b4ed",
  "sasUri": ""
}

Get Status

You can retrieve information on the printjob state with the following request:

GET https://printapi.ezeep.com/sfapi/Status/?:id

Parameters:

Example request:

curl -X GET \
 "https://printapi.ezeep.com/sfapi/status/?id=ezprnds-p00000M:HP%20Co_tpcb_4936_114813343#1801071420:1" \
 -H "Authorization: Bearer <access__token"  
 

Example response:

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

Status Codes

These codes are expected and should be handled adequately.

Error codes

Stuck with an error code? We are using Microsoft error codes that are represented by an integer. Find a comprehensive list here: https://docs.microsoft.com/en-us/windows/win32/debug/system-error-codes