Documentation

n8n      AvantGuard

Printix n8n Node

n8n community node npm

The Printix Cloud Print API is intended for use by applications that wish to push print jobs in PDF or native format into a Printix queue. It also provides management endpoints for users, groups, sites, networks, SNMP configurations, cards, and workstations. This API makes use of the HAL document format and is intended to be discoverable.

Table of Contents

Installation

Follow the n8n community node installation guide.

Or install directly via npm:

npm install @avantguardllc/n8n-nodes-printix

Authentication

This node authenticates using OAuth 2.0.

Setting Value
Type OAuth2
Flow clientCredentials
Token URL https://auth.printix.net/oauth/token
Base URL https://api.printix.net/cloudprint/tenants/{tenantId} (editable in credentials)

Tip: The Base URL can be changed in the credential settings if your instance uses a different host.

Resources & Operations

Base URL: https://api.printix.net/cloudprint/tenants/{tenantId}

Printers

Endpoint Description
🔵 GET /printers List printers
🔵 GET /printers/{printerId}/queues/{queueId} Get printer properties

Jobs

Endpoint Description
🟢 POST /printers/{printerId}/queues/{queueId}/submit Submit a print job
🔵 GET /printers/{printerId}/queues/{queueId}/jobs List jobs for a specific printer queue
🔵 GET /jobs Retrieve all jobs
🔵 GET /jobs/{jobId} Retrieve a single job
🟢 POST /jobs/{jobId}/delete Delete a job
🟢 POST /jobs/{jobId}/changeOwner Change job owner
🟢 POST /jobs/{jobId}/completeUpload Complete upload

Users

Endpoint Description
🔵 GET /users List users
🟢 POST /users/create Create a guest user
🔵 GET /users/{userId} Find user by ID
🟢 POST /users/{userId}/delete Delete a user
🟢 POST /users/{userId}/idCode Generate ID code

Cards

Endpoint Description
🟢 POST /users/{userId}/cards Register a card
🔵 GET /cards/{card} Search for a card
🔴 DELETE /cards/{card} Delete a card

Groups

Endpoint Description
🔵 GET /groups List and search groups
🟢 POST /groups Create a group
🔵 GET /groups/{groupId} Fetch group details
🔴 DELETE /groups/{groupId} Delete a group

Sites

Endpoint Description
🔵 GET /sites Query sites
🟢 POST /sites Create a site
🔵 GET /sites/{siteId} Retrieve a site
🟡 PUT /sites/{siteId} Update a site
🔴 DELETE /sites/{siteId} Delete a site

Networks

Endpoint Description
🔵 GET /networks Query networks
🟢 POST /networks Create a network
🔵 GET /networks/{networkId} Retrieve a network
🟡 PUT /networks/{networkId} Update a network
🔴 DELETE /networks/{networkId} Delete a network

SNMP

Endpoint Description
🔵 GET /snmp Query SNMP configurations
🟢 POST /snmp Create SNMP configuration
🔵 GET /snmp/{snmpId} Retrieve SNMP configuration
🟡 PUT /snmp/{snmpId} Update SNMP configuration
🔴 DELETE /snmp/{snmpId} Delete SNMP configuration

Workstations

Endpoint Description
🔵 GET /workstations Query workstations
🔵 GET /workstations/{workstationId} Retrieve a workstation

Compatibility

  • n8n version: 1.0+ (tested on 2.x)
  • Node.js version: 18+

License

MIT

Discussion