@crvouga/ mockingbird-service-easypost (英语)

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

国家模拟器 网易邮箱 测试套件的 API : POST /v2/trackers (创建或 重新使用跟踪码, GET /v2/trackers/{id} 财务报告和审定财务报表 GET /v2/trackers网易邮报 记录的测试跟踪代码解答其固定状态,任何其他代码都通过 管理员过渡,所以基因组管理员的航运腿状态可以被驱动决定.

• 行动范围: 支助
• 合同openapi.yaml从EasyPost发表的关于我们 跟踪搜索( e)packages/lib/src/shipment-tracking-status/easypost-client.ts(电话).

安装

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

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

使用量

应用程序硬码 https://api.easypost.com/v2/trackers (接缝) G-Y1级: 向 easypost-client.ts) (中文(简体) ). 将基准 URL 指向模拟器; EASYPOST_API_KEY 可以是任意值 (单位:千美元)--api-key 限制它).

npx mockingbird-easypost serve --port 8818

import EasyPostClient from "@easypost/api"
import { createServer } from "@crvouga/mockingbird-service-easypost/server"

const server = await createServer()

// Test setup: seed a status before the app looks the code up (or move an existing tracker).
await fetch(`${server.url}/__admin/trackers/1Z999AA10123456784/transition`, {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({ status: "out_for_delivery" }),
})

// The EasyPost SDK your application already uses. Only its base URL changes.
// @ts-ignore @easypost/api 8.9.0 types its ESM default export as CommonJS (NodeNext only).
const easypost = new EasyPostClient("EZTK_test", { baseUrl: `${server.url}/v2/` })
const tracker = await easypost.Tracker.create({ tracking_code: "1Z999AA10123456784", carrier: "UPS" })
console.log(tracker.id, tracker.status, tracker.carrier) // trk_… out_for_delivery UPS

await server.close()

路线

每一个错误都是 EasyPost 的信封 {error: {code, message, errors}};我们的客户端读 error.message。缺失的密钥为 401 APIKEY.REQUIRED,外部键 apiKeys 401 (中文(简体) ) APIKEY.INACTIVE键开始 EZAK 生产模式(测试代码不特殊); 其他的都是测试模式.

测试跟踪代码 (试验模式,载体) USPS: EZ1000000001 传输前( t), EZ2000000002 中转, EZ3000000003 运出( f), EZ4000000004 交付, EZ5000000005 返回到发件人( s), EZ6000000006 失败, EZ7000000007 不详。 任何其他代码 开始 unknown 编号 : unknown。 。 。 .

管理员(超过标准合同)

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n}: rate_limited (429个), server_error (500个), invalid_api_key (401个), gateway_html (502 HTML,我们的客户掉头了) 改为 EasyPost tracker request failed (502), (中文(简体) ), connection_drop (拒绝;我们的批量检查) 记录 unknown 你应当警告, slow (5s) (英语).

命名空间

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

故意不模拟

• 追踪器 Webhooks (tracker.updated, (中文(简体) ), X-Hmac-Signature我们的应用程序没有接收器.
• 载体外观: 真实形状的代码从不自行移动; 状态来自管理员 过渡.
• 运输、费率、标签、地址、批发和所有其他的EasyPost资源.
• 相位光标( P)before_id 编号 : after_id名单中: page_size 财务报告和审定财务报表 has_more 只有这个.

API 密码

部分 嘲笑鸟。 。 。 .