@crvouga/mockingbird-service-first促进者

本地模拟器。 真正的API合同. 部分 嘲笑鸟。 。 。 .

国家模拟器 第一促进者 v2 测试套房的附属 API: 促销者创建( 采用) 在创建前 cust_id),由 id / 查看 cust_id 编号 : ref_token / 电子邮件、 列表、 更新, 归档、 仪表板 iframe 登录、 登录跟踪 tid, (中文(简体) ), promoter_id 或证明, 和基本事实 lead_becomes_referral webhook我们的后端收到。 每个请求都是 在日记中记录,所以一个离职套件 可以断言 离职后的工作发送 生产失败的工作.

• 行动范围: 支助
• 第一促进者不公布机器可读规格:合同openapi.yaml)为 由我们消费者的要求 和zod计划 来验证反应.

安装

npm install -D @crvouga/mockingbird-service-firstpromoter

仅限无害环境管理。 节点 22或 Bun 1.2. 无土生属地. 给它服务 npx mockingbird-firstpromoter serve, (中文(简体) ), createServer 从 ./server (节点),或 createRuntime 与任何获取服务器.

使用量

点 FIRST_PROMOTER_API_URL 在模拟器(我们的Joi计划需要 https,所以无论前面 设置任意 FIRST_PROMOTER_API_KEY 财务报告和审定财务报表 FIRST_PROMOTER_ACCOUNT_ID,并传出网球 Basic-auth 配对为 --webhook-secret。 。 。 .

npx mockingbird-firstpromoter serve --port 8812 \
  --webhook-url http://127.0.0.1:3000/users/webhooks/first-promoter \
  --webhook-secret "$FIRST_PROMOTER_WEBHOOK_AUTH_USERNAME:$FIRST_PROMOTER_WEBHOOK_AUTH_PASSWORD"

import { createServer } from "@crvouga/mockingbird-service-firstpromoter/server"

// Test setup: the emulator, an existing affiliate, and a click on their link.
const server = await createServer({
  webhooks: { url: "http://127.0.0.1:3000/users/webhooks/first-promoter", secret: "user:pass" },
})
const admin = (path: string, body: unknown) =>
  fetch(`${server.url}/__admin${path}`, {
    method: "POST",
    headers: { "content-type": "application/json" },
    body: JSON.stringify(body),
  })
await admin("/promoters", { email: "[email protected]", ref_token: "nate91" })
// The tid checkout stores as fp_tid.
const { tid } = (await (await admin("/clicks", { ref_token: "nate91" })).json()) as { tid: string }

// Application code: FIRST_PROMOTER_API_URL is server.url. The invoice handler tracks the signup.
const baseUrl = server.url
const tracked = await fetch(`${baseUrl}/v2/track/signup`, {
  method: "POST",
  headers: {
    authorization: "Bearer fp-api-key",
    "Account-ID": "acct_1",
    "content-type": "application/json",
  },
  body: JSON.stringify({ email: "[email protected]", tid }),
})
// The emulator converts the referral and posts lead_becomes_referral to the backend with
// Authorization: Basic…
await server.close()

路线

这个 正式转诊参考 指定空阵列。 追踪参数和限制 n8n 客户端 财务报告和审定财务报表 输入定义。 。 。 .

每个电话都需要 Authorization: Bearer <key> 还有一个 Account-ID 标题 (else 401).

网络呼号

lead_becomes_referral 身体和我们一样 FirstPromoterNewCustomerWebhookSchema数字 : {event: {id, type, created_at}, data: {id, state, email, customer_since, promotion: {id, promoter_id, ref_id, leads_count, customers_count, current_referral_reward}, promoter: {id, cust_id, email, earnings_balance: {cash}}}},随同发送 Authorization: Basic base64(<secret>) 在其中的秘密 实值 user:pass非-2xx的答案被重审; GET /__admin/webhooks, (中文(简体) ), …/events, (中文(简体) ), …/flush 财务报告和审定财务报表 PUT /__admin/webhook-endpoints 工作如常.

管理员(超过标准合同)

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n}· ; GET /__admin/faults/presets: created_but_500 (储存,然后500: 重试必须被 cust_id, (中文(简体) ), lookup_unavailable (看503:既不创建也不收养), no_campaign (无) promoter_campaigns:无参考链接, unauthorized, (中文(简体) ), rate_limited, (中文(简体) ), server_error, (中文(简体) ), connection_drop, (中文(简体) ), webhook_duplicate, (中文(简体) ), webhook_drop。 。 。 .

FirstPromoter的调解程序 公布的合同数字 : GET /v2/company/commissions 返回一个赤色阵列,首先是最新的阵列,带有 q,重复 ids[], (中文(简体) ), page 编号 : per_page (默认为 1 / 20, 最多为 100) , 以及过滤器 status非货币 fulfilled=yes|no货币 paid=yes|no, (中文(简体) ), promoter_id, (中文(简体) ), campaign_id,金额/销售额 范围和创建日期范围. POST …/commissions/mark_fulfilled 非货币 佣金; DELETE …/commissions/destroy 删除选定的佣金。 两个都拿 {ids}。 。 。 . 最多5个身份证的批次返回200个/已完成;较大批次返回202个/待定。 在那个 模拟器在时钟前进后移动到进取点,然后以 1 000 ms 完成 认证API电话。 批次的藏品和有待完成的工作参与重设和快照. GET …/batch_processes 财务报告和审定财务报表 …/batch_processes/progress 默认列出未完成的工作 (单位:千美元)filters[status] 选择其他状态; GET …/batch_processes/{id} 返回计数和 处理错误. batch_partial_failure 处理时失败第一个选中的项目 别人。 时间、缺失ID/货币项目错误文本,而这个预设是合成控制; 它们不是关于供应商工人时间或确切错误信息的索赔。 完成为 与供应商分开储存 is_paid 货币领域.

POST /v2/track/sale 照着卖家的 销售合同数字 : {event_id, amount, email|uid, currency?, plan?, promo_code?, ref_id?, tid?, skip_email_notification?} 在跟踪查询中记录了小单位的正整数。 第一个配置 运动奖励提供核定佣金; 奖励百分比四舍五入到最近的 小单位,平价奖励使用其配置的金额。 现金奖励也计入现有 促销者平衡;非货币性奖励没有. 答复包括转介、数额和 链接的佣金,在佣金收藏中可见。 重放事件ID返回 记录409,没有其他信用,佣金或网络hook。 未知的推荐文件,存档 宣传员和提供未匹配的归属标志归还文件404 not_found 形状. 代码必须通过管理员控制进行播种;符号必须属于推荐人的推广者 竞选。 所有验证都先于发售/委托/平衡写入;快照/重置包含事件 相去相减. 成功的发售保留了现有的转换webhook行为.

没有铅匹配时 email 编号 : uid卖家的 跟踪合同 让我们 tid 或者说 ref_id "通过签注追踪": 创建了主角并指定了销售在 一个请求。 模拟器在 tid (点击 POST /__admin/clicks)或(或) ref_id 确定一个现场宣传员 请求中指定了领先者 email; 新线索数 向推销员推荐,成为顾客和帖子 lead_becomes_referral这是 docs-验证(上面的追踪OpenAPI),而不是甲骨文验证. uid 单靠自己不能给新线索起名, 还有一个 email 这已经是另一条线索了 uid 是422(如注册跟踪).

promo_code 独活:最佳猜测,不是甲骨文验证. 供应商没有提供进一步文件 promo_code ("用于促进码追踪"),所以只携带促进码的销售是否创造了 铅是不可观察的。 默认( E)promoCodeCreatesReferral: false:为未知的买方出售 仅限 promo_code 与任何未分配的销售相同 404, 并且没有存储。 打开 PUT /__admin/settings {"promoCodeCreatesReferral": true} 要有一个代码种子通过 POST /__admin/promo-codes 创建铅( 需要) email),将销售转让给拥有 竞选注册人数和职位 lead_becomes_referral完全一样 tid 编号 : ref_id。一个 未种子代码在两种模式中为404. 将取决于此设置的测试视为取决于 模拟者假设,直到现场反应被捕获.

命名空间

x-mockingbird-namespace页:1 /__admin/ns/<name> 前缀在 FIRST_PROMOTER_API_URL,或用 API 键: PUT /__admin/credentials {"credentials": {"<FIRST_PROMOTER_API_KEY>": "<namespace>"}}。 。 。 .

故意不模拟

• 错误机构和真实API的确切状态代码未经核实(没有沙盒证书): 错误使用 {message} 和审定 {message, errors: {field: [...]}}我们的消费者 分支 ok / 404,模拟器得到正确.
• V1 API 我们的EMR后端仍然打电话来/v1/promoters/*, (中文(简体) ), /v1/track/signup, (中文(简体) ), /v1/reports/campaigns);目录将这个仿真器瞄准 v2.
• 退款、独立设立/编辑/核准佣金、现金支付和佣金过滤器 - 欺诈检查; 公共宣传码的提供; iframe sords后方的托管附属门户.
• 创建线索从 promo_code 默认单独关闭( e)promoCodeCreatesReferral:供应商仅为 tid 财务报告和审定财务报表 ref_id,所以选入行为是一个最好的猜测,而不是甲骨文验证.
• 货币记录不采用外汇兑换;具体计划的奖励、数量/ 计算,多级奖励,分出佣金和通知电子邮件没有模式化. 佣金四舍五入和立即批准是决定性的仿真政策,而不是现场核查 竞选政策。 与以往一样,缺席竞选奖金仍为10%.
• 转出编辑/删除,用户名/网站配置提供,取消日期过滤和分出归属.
• 促销码由每个命名空间4800001相继出.

API 密码

部分 嘲笑鸟。 。 。 .