Choose an integration
Use a platform account, a workspace API key, or an interactive node flow without mixing their trust boundaries.
Headless platform
Best for SaaS products, fulfilment systems, marketplaces, and design tools serving many customer organisations. Your backend keeps one platform key, maps each authenticated organisation to an immutable external ID, and manages isolated customer accounts through the API or SDK.
- Create, retrieve, list, and archive customer accounts.
- Use isolated Test and Live environments for every customer.
- List nodes, printers, profiles, targets, jobs, API keys, and webhooks.
- Send PDFs without implementing upload or digest plumbing.
- Keep all platform and tenant selection decisions on the server.
Single-workspace backend
Best for one company adding printing to its own application. Create a scoped Live or Test API key in Developers, then use PiqaeClient directly.
import { PiqaeClient } from '@piqae/sdk';
const piqae = new PiqaeClient({
apiKey: process.env.PIQAE_API_KEY!
});
const printers = await piqae.printers.list();
const jobs = await piqae.jobs.list({ limit: 25 });Interactive desktop or operator flow
Best when a person installs a node, chooses native driver settings, or monitors a local queue. Pair the thin tray app in a browser. The node keeps a device credential in Keychain or DPAPI and does not retain the person’s web session.
Local-only
Best for a single machine that must print without any control plane. Use the loopback API and local SQLite queue. Platform accounts, workspace members, and hosted webhooks are intentionally absent.