zplflow logo
en
Login

Introduction

zplflow is an API-first platform for thermal label conversion. It converts between PDF and ZPL (Zebra Programming Language), applies programmable transformations via pipelines, and handles both synchronous and asynchronous workflows.

Base URL: https://api.zplflow/v1

Key Concepts

Jobs

Every conversion is tracked as a job. Jobs have a lifecycle:

created → queued → running → succeeded
                        ↘ failed
created → canceled
Status Meaning
created Awaiting document upload
queued Submitted to async worker
running Worker processing
succeeded Output ready
failed Error occurred, tokens returned
canceled User cancelled

Tokens

Tokens are the platform’s resource unit. Each operation costs a fixed amount debited from your account balance.

PDF → ZPL (per page): 1-5 tokens depending on DPI and MaxKB.
ZPL → PDF: 1 token (fixed).
Pipeline: Sum of step costs (1-3 tokens each).

See Conversions for the full pricing table.

Quick Start

1. Get your API key from the dashboard

2. Convert a PDF to ZPL (sync)

curl -X POST "https://api.zplflow/v1/convert/pdf-to-zpl?dpi=203&max_kb=64" \
  -H "Authorization: Bearer lb_live_YOUR_KEY" \
  -H "Content-Type: application/pdf" \
  -H "Idempotency-Key: unique-request-id" \
  --data-binary @label.pdf

3. Convert ZPL to PDF


curl -X POST "https://api.zplflow/v1/convert/zpl-to-pdf" \
  -H "Authorization: Bearer lb_live_YOUR_KEY" \
  -H "Content-Type: text/plain" \
  -H "Idempotency-Key: unique-request-id" \
  --data-binary '^XA^FO50,50^A0N,30,30^FDHello^FS^XZ'

See Installation for signup and API key setup.

Next Steps