Quickstart

This guide takes you from a new account to a printed page. You will create a test key, print to a virtual test printer, then install the agent and print to a real printer with a live key.

Create an account and a test key

Sign in at app.printeasy.adfinite.com with your email. We send a one time code, no password needed. Open API keys, create a key with Test mode on and the print scope, and copy it. It is shown once.

export PRINTEASY_API_KEY="pe_test_your_key"

Check the key

Call whoami to confirm the key works and see which organization and mode it belongs to.

curl https://api.printeasy.adfinite.com/v1/whoami \
  -H "Authorization: Bearer $PRINTEASY_API_KEY"

List printers

Test keys see the four virtual printers on PrintEasy Test Computer. Copy the id of “Test A4 Laser”.

curl https://api.printeasy.adfinite.com/v1/printers \
  -H "Authorization: Bearer $PRINTEASY_API_KEY"

Send a PDF by URL. The job walks from queued to done in about 3 seconds.

curl https://api.printeasy.adfinite.com/v1/printjobs \
  -H "Authorization: Bearer $PRINTEASY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"printerId":"PRINTER_ID","title":"Hello","contentType":"pdf_uri","content":"https://printeasy.adfinite.com/sample.pdf"}'

Or use an SDK, which also waits for the job to finish:

import { PrintEasy } from "@printeasy/sdk";

const pe = new PrintEasy({ apiKey: process.env.PRINTEASY_API_KEY });
const printerId = "PRINTER_ID";
const url = "https://printeasy.adfinite.com/sample.pdf";

const job = await pe.printJobs.createAndWait({ printerId, title: "Hello", contentType: "pdf_uri", content: url });
console.log(job.state);

from printeasy import PrintEasy

pe = PrintEasy()  # reads PRINTEASY_API_KEY
printer_id = "PRINTER_ID"
url = "https://printeasy.adfinite.com/sample.pdf"

job = pe.print_jobs.create_and_wait({"printerId": printer_id, "title": "Hello", "contentType": "pdf_uri", "content": url})
print(job["state"])

Go live with a real printer

Install the agent on a computer that has a printer, approve it in the dashboard and mark the printer live. Then create a key without Test mode (it starts with pe_live_), list printers again and repeat the print call with the real printer id.

Next steps

Read Printing PDFs for the job fields, limits and states.
Subscribe to webhooks instead of polling.
Learn how test mode behaves so your tests match production.

Get started

Printing

Build

SDKs

Migrate

Next steps

​Next steps

Next steps