介绍
API 参考
介绍
Agent & WebSocketGet Started
PrintBasePrintBase
介绍

Get Started

Get Started

本指南帮助你从 0 到 1 完成首个打印任务。

1. 服务地址

生产地址:

https://api.printbase.cloud

2. 用户注册与登录(Web)

注册:

curl -X POST https://api.printbase.cloud/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email":"admin@example.com",
    "password":"Passw0rd!",
    "name":"Admin"
  }'

登录:

curl -X POST https://api.printbase.cloud/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"admin@example.com","password":"Passw0rd!"}'

将返回 token 用于 Authorization: Bearer <TOKEN>。

3. 创建服务端 API Key

curl -X POST https://api.printbase.cloud/v1/api-keys \
  -H "Authorization: Bearer <USER_JWT>" \
  -H "Content-Type: application/json" \
  -d '{"name":"backend-service"}'

4. 连接 Agent

在本地机器运行 Agent:

PRINTBASE_API_KEY=pb_live_xxx ./agent-darwin-arm64

也可以用账号密码登录,让 Agent 自动获取用户 token:

PRINTBASE_EMAIL=admin@example.com \
PRINTBASE_PASSWORD='Passw0rd!' \
./agent-darwin-arm64

桌面版 agent-client 也支持同一流程:在 Setup 中选择 Account,填写邮箱和密码后保存启动。

桌面版 agent-client 还可以在 About 中启用本地网页打印。启用后监听 http://127.0.0.1:17891,接收同样的 POST /v1/print-jobs 请求结构,先本地打印,再异步补云端任务记录。

Agent 会自动注册、上报打印机并建立 WebSocket 长连接。

5. 创建首个打印任务

curl -X POST https://api.printbase.cloud/v1/print-jobs \
  -H "Authorization: Bearer pb_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "printer_code":1000000,
    "content_type":"pdf",
    "content":"JVBERi0xLjQK...",
    "copies":1,
    "options":{"duplex":false}
  }'

如果 PDF 或 raw 文件已经有公网 HTTP/HTTPS URL,也可以用 content_url 替代 content:

{
  "printer_code": 1000000,
  "content_type": "pdf",
  "content_url": "https://example.com/label.pdf",
  "copies": 1
}

预期返回:

{ "id": "job_xxx", "status": "queued" }

Agent & WebSocket

Previous Page

On this page

Get Started
1. 服务地址
2. 用户注册与登录(Web)
3. 创建服务端 API Key
4. 连接 Agent
5. 创建首个打印任务