⟨ / ⟩ BinaryPHP

API 文档

程序化编码 — 限 Ultra 订阅用户使用。请到 账户 → API 密钥创建密钥，将密钥直接放在以下端点 URL 中即可。

方案上限

方案单文件上限API 访问需要 multipart 吗？
Free 5 KB — —
Pro 100 MB — 否（单次 PUT 即可）
Ultra 300 MB 有 文件 >100 MB 必须走 multipart

Cloudflare 边缘对单一 request body 上限为 100 MB。超过此值的文件， 必须切成 50 MB 的 part 并走下方的 multipart 端点。

单次 PUT 上传（≤100 MB）

POST https://webhook.binaryphp.com/upload/<api_key>
  X-BPHP-Filename: plugin.php          # 必填，扩展名 .php 或 .zip
  X-BPHP-Domain:   app.example.com,*.example.com
  X-BPHP-Mac:      aa:bb:cc:dd:ee:ff   # 可选
  X-BPHP-Expire:   2027-12-31          # 可选
  X-BPHP-Webhook:  https://you.example.com/wh    # 可选，异步通知用
  <文件二进制内容作为 request body>

→ 200 {
    "job_id":       "...",
    "download_url": "https://...presigned R2 URL...",
    "expires_at":   "2026-05-09T...",
    "size":         12345,
    "license":      { "domains": [...], ... }
  }

curl 一行版：

curl -X POST https://webhook.binaryphp.com/upload/$API_KEY \
  -H "X-BPHP-Filename: plugin.php" \
  -H "X-BPHP-Domain: app.example.com" \
  --data-binary @plugin.php

Multipart 上传（任意大小，>100 MB 必走）

三步骤：init → 单独 PUT 每个 part → complete。

1. Init（初始化）

POST https://webhook.binaryphp.com/upload/<api_key>/init
  X-BPHP-Filename:   bigplugin.zip
  X-BPHP-Total-Size: 200000000

→ 200 {
    "job_id":     "...",
    "upload_id":  "...",                         # R2 multipart 不透明 id
    "r2_key":     "uploads/<job_id>.zip",
    "part_size":  52428800,                      # 建议 50 MB 一片
    "part_count": 4,
    "max_part_size": 104857600,                  # 100 MB 硬限制
    "parts": [
      { "part_no": 1, "upload_url": "https://...presigned PUT..." },
      { "part_no": 2, "upload_url": "..." },
      { "part_no": 3, "upload_url": "..." },
      { "part_no": 4, "upload_url": "..." }
    ]
  }

2. 对每个 upload_url 做 PUT

这些预签名 URL 直接打 R2，不消耗 Worker 带宽。 每个 PUT 响应的 ETag header 必须收集起来，complete 阶段一并送上：

PUT <upload_url>
  <从文件 (part_no-1)*part_size 偏移处读取 part_size 个 bytes>

← 200 OK
  ETag: "abc123def456..."

每个 part 必须 ≥5 MB（最后一片可小于），且 ≤100 MB。

3. Complete（完成）

POST https://webhook.binaryphp.com/upload/<api_key>/complete
Content-Type: application/json

{
  "upload_id": "...",
  "r2_key":    "uploads/<job_id>.zip",
  "filename":  "bigplugin.zip",
  "parts": [
    { "part_no": 1, "etag": "\"abc...\"" },
    { "part_no": 2, "etag": "\"def...\"" },
    { "part_no": 3, "etag": "\"ghi...\"" },
    { "part_no": 4, "etag": "\"jkl...\"" }
  ],
  "domain":   "app.example.com",
  "mac":      "",
  "expire":   "2027-12-31",
  "plugin":   "",
  "webhook":  ""
}

→ 200 { "job_id", "download_url", "expires_at", "size", "license" }

Abort（可选）

若中途 part 上传失败，请调用 /upload/<api_key>/abort 并带上 { upload_id, r2_key }，避免残留的 part 留在 R2 计费。

Webhook 通知

设置 X-BPHP-Webhook（或 complete body 中的 "webhook"） 以接收 encode.completed 事件。通知由 Cloudflare 边缘 IP 发出， 不会泄露我们主机 IP。Body 以你的 API key 为共享密钥用 HMAC-SHA256 签名：

POST <你的 webhook URL>
  X-BinaryPHP-Signature: t=1736208000,v1=<hex>
  X-BinaryPHP-Event:     encode.completed
  Content-Type:          application/json

{
  "event":        "encode.completed",
  "job_id":       "...",
  "download_url": "...",
  "expires_at":   "...",
  "size":         12345,
  "license":      { ... }
}

验证示例（PHP）：

$sig_h = $_SERVER['HTTP_X_BINARYPHP_SIGNATURE'] ?? '';
[$tpart, $vpart] = array_pad(explode(',', $sig_h, 2), 2, '');
$ts  = (int) substr($tpart, 2);
$got = substr($vpart, 3);
if (abs(time() - $ts) > 300) http_response_code(401);
$body = file_get_contents('php://input');
$expected = hash_hmac('sha256', "$ts.$body", $YOUR_API_KEY);
if (!hash_equals($expected, $got)) http_response_code(401);

现成可用的客户端

常见错误

状态码含义处理方式
401密钥错误或已撤销 到「账户 → API 密钥」重新创建
402方案不支持此操作（如 Free 上传 zip） 升级方案
413文件 / Content-Length 超过方案上限 改走 multipart，或升 Pro→Ultra（300 MB）
400缺字段或格式错（filename、parts 等） 查看响应 body，会指出缺哪个字段
502R2 multipart 操作失败 重试 init；R2 偶有 <1% 概率失败