用途:帮助开发者将自有系统的用户数据推送到 Portaly Vibe,使创作者可在仪表盘查看用户及其 Portaly 订阅状态。Portaly 侧为只读镜像加订阅状态叠加,数据源仍在开发者系统内。
主要能力:通过推送式同步 API(POST /api/creator-subscription/admin/users/sync)上传用户;可用字段包括 email(必填,去重键)、external_user_id、display_name、status(active 或 deleted)、role、plan_name、last_login_at、created_at、metadata(上限 10KB)、signup_ref_code。仪表盘位于 https://portaly.ai/dashboard/members,只读,变更均来自同步 API;无订阅显示为 Free。
使用方式:先获得用户明确同意,再读取其用户模型做字段映射,确认 PORTALY_API_KEY(环境变量,pcs_live_* 为生产、pcs_test_* 为测试),API 主机默认 https://portaly.ai,可用 PORTALY_API_HOST 覆盖。随后新增 syncToPortaly 批处理辅助函数,并接入注册、登录、资料更新、删除等生命周期钩子,调用须为 fire-and-forget,失败仅记录日志,不得阻断主流程。全量迁移可选本地直接执行,或生成 scripts/sync-portaly-once.mjs 在生产环境跑一次。
限制:同步 API 只接受 API Key 认证,GET 端点可接受 API Key 或 Firebase JWT;批量大小为 100,遇 429 需按 Retry-After 退避重试。signup_ref_code 首写生效,后续同步不可覆盖,且该码需先在 Portaly 创建,未知码会被静默丢弃。同步可能触发 Portaly 默认欢迎邮件,需先按 portaly-email 技能禁用对应模板以免重复发送。资料未提供收费、价格与平台支持范围的说明。