Docs

Quickstart

1. Create an account

Sign up at https://app.printsocket.com. There is no password: you get a sign-in link by email. Name your account and you land on the dashboard.

2. Get an API key

In Settings → API keys, create a key. Pick test mode to start: test keys get a virtual device and printer that simulates the whole job lifecycle, so you can build before any hardware is involved. The secret is shown once, so store it now.

curl https://api.printsocket.com/v1/me \
  -H "Authorization: Bearer sk_test_..."

3. Enroll a machine

When you are ready for real printers, open Devices → Add device. That gives you a single-use enrollment token and the installer links. Install the agent on the machine that talks to your printers, then enroll it:

psagent enroll -token enr_... -server https://api.printsocket.com
psagent run

The agent connects outbound over a WebSocket, so nothing needs to be reachable from the internet. It reports every printer queue it can see, with capabilities, and keeps them updated.

4. Find your printer

curl "https://api.printsocket.com/v1/printers?state=online" \
  -H "Authorization: Bearer sk_test_..."

5. Send a job

curl https://api.printsocket.com/v1/jobs \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-12345" \
  -d '{
    "printer_id": "prn_8f2k1",
    "title": "Order #12345 label",
    "content": { "format": "pdf", "url": "https://example.com/label.pdf" },
    "options": { "paper": "A4" }
  }'

On Node.js, PHP, or Python, the official clients (printsocket-node, printsocket-php, printsocket-python) wrap the same call, along with the rest of the API:

npm install printsocket
composer require printsocket/printsocket
pip install printsocket

import PrintSocket from "printsocket";

const ps = new PrintSocket({ apiKey: "sk_test_..." });
const job = await ps.jobs.create({
  printer_id: "prn_8f2k1",
  title: "Order #12345 label",
  content: { format: "pdf", url: "https://example.com/label.pdf" },
  options: { paper: "A4" }
});

$ps = new PrintSocket\PrintSocketClient(['api_key' => 'sk_test_...']);
$job = $ps->jobs->create([
  'printer_id' => 'prn_8f2k1',
  'title' => 'Order #12345 label',
  'content' => ['format' => 'pdf', 'url' => 'https://example.com/label.pdf'],
  'options' => ['paper' => 'A4'],
]);

ps = printsocket.PrintSocket(api_key="sk_test_...")
job = ps.jobs.create({
    "printer_id": "prn_8f2k1",
    "title": "Order #12345 label",
    "content": {"format": "pdf", "url": "https://example.com/label.pdf"},
    "options": {"paper": "A4"},
})

Poll GET /v1/jobs/{id}, read the transition history at GET /v1/jobs/{id}/events, or register a webhook and get pushed the state changes as they happen. Everything on this page is also doable from the dashboard, including sending a test print without writing any code.