开始使用

快速开始

五分钟:签发一枚凭证,发第一个请求,存一条草稿,再把它排期。

四步

  1. 01签发长期凭证

    登录 popkit → 设置 → 「接入外部系统」 → 「长期凭证」 → 「签发新凭证」:起个名字,勾选权限(至少 workspace:read、accounts:read、posts:read、posts:write),要排期就再勾「定时发布」落点。密钥以 popkit_it_ 开头,只显示一次,复制走。只有工作区管理员能签发。

  2. 02第一个请求:我是谁

    调 GET /api/v1/workspace,确认凭证、工作区、scope 与配额都对。

    curl "https://popkit.loxily.com/api/v1/workspace" \
      -H "Authorization: Bearer popkit_it_••••••••"
  3. 03存一条草稿

    调 POST /api/v1/posts,action: "draft"。草稿档预检只提示不拦,可以先存后改;返回的 postId 后面都要用。

    curl -X POST "https://popkit.loxily.com/api/v1/posts" \
      -H "Authorization: Bearer popkit_it_••••••••" \
      -H "Content-Type: application/json" \
      -d '{
      "action": "draft",
      "content": "新功能上线:一次创作,发布到所有平台 🚀",
      "platforms": [
        "x",
        "instagram"
      ]
    }'
  4. 04排期并查结果

    用 PATCH /api/v1/posts/{postId} 把它改成 action: "schedule" 并给 scheduledAt(必须带时区);带上 Idempotency-Key,重试不会重复。到点后用 GET /api/v1/posts/{postId} 看逐账号结果。

    curl -X PATCH "https://popkit.loxily.com/api/v1/posts/pst_01J8ZK3R7QW6M2" \
      -H "Authorization: Bearer popkit_it_••••••••" \
      -H "Content-Type: application/json" \
      -H "Idempotency-Key: acme-2026-09-21-001" \
      -d '{
      "action": "schedule",
      "content": "新功能上线:一次创作,发布到所有平台 🚀",
      "platforms": [
        "x",
        "instagram"
      ],
      "scheduledAt": "2026-09-21T18:00:00+08:00"
    }'

接下来

  • 发布前先跑 发布预检:口径与真实发布一致,ok=true 才值得发。
  • 要发图 / 视频,先用 上传素材 换 mediaUrl,再填进 media[].dataUrl。
  • action: "publish" 是立即对外发布:必须带 Idempotency-Key,凭证要勾了「立即发布」落点;详见 鉴权与权限。
  • 所有错误按 error.code 处理,见 错误码;分页、限流、幂等的细则见 约定。