打开开发者门户，查看您的账户可访问的 API 及当前环境提供的 SDK。需要先登录，并具备相应的账户权限。
TypeScript SDK
以下为在服务端使用 Ysend 客户端的 TypeScript 示例。请配置接入时约定的 API 基础地址，并将 API 密钥保存在服务端环境变量中。
import { Ysend } from "@ysend/sdk";
const ysend = new Ysend({
baseUrl: process.env.YSEND_API_BASE_URL!,
apiKey: process.env.YSEND_API_KEY!,
});
const stock = await ysend.inventory.listBalances({ page: 1, pageSize: 20 });
const orders = await ysend.orders.list({ status: "Open", page: 1, pageSize: 20 });
const shipments = await ysend.shipments.list({ page: 1, pageSize: 20 });此示例需要 inventory:read、orders:read 和 shipments:read 权限。使用 SDK 写入数据时，请提供稳定的 Idempotency-Key，以允许重试并避免重复创建操作。
请使用 Node.js 20 或更新版本。如果门户提供 SDK，请记录版本和文件名，并核对下载文件的 SHA-256。将下面的 PACKAGE_FILE.tgz 替换为门户显示的准确文件名。
npm install ./PACKAGE_FILE.tgzYSEND_API_BASE_URL 应填写约定的 API 源地址，即 HTTPS 协议和主机，不要附加 /api/v1；SDK 会添加该路径。YSEND_API_KEY 应保存在服务端，请求通过 X-Api-Key 传递密钥。
每次列表调用返回一页数据。请指定 page 和 pageSize，并在响应提供时检查 items、totalCount、page 和 pageSize，再请求下一页。第一页不等于完整导出。
YsendError 提供可用的 HTTP 状态、detail 和 traceId。YsendTransportError 表示未收到可用响应，此时写入操作的结果可能尚不明确。
默认总计尝试三次，每次尝试等待响应头的超时为 30 秒。GET/HEAD 以及带有 Idempotency-Key 的请求，可在网络错误或 HTTP 429、502、503、504 后重试。同一操作应重复使用同一密钥。orders.list 使用未附带该密钥的 POST，因此不执行上述自动重试。
尚未获得访问权限或 SDK？请在项目咨询中说明需要测试的数据交换。在测试前确认 API 源地址、软件包版本、适用的 API 文档、测试账户及权限。请勿提交密钥等机密信息。
开始使用
账户激活后，由获授权的管理员创建密钥，并分配集成所需的权限。
如果您的环境已发布 SDK 软件包，请在开发者门户下载，核对 SHA-256 后安装下载的文件。
在密钥获授权的范围内，查询库存、订单和发运记录。
Webhook
在应用中创建订阅，通过 Ping 测试，并查看每次投递记录。Outbox 会对符合条件的失败进行重试；达到重试上限的事件仍保留在失败队列中，便于排查。
覆盖范围
导入 CSV 或结构化数据行；查看、修正并重新提交被拒绝的数据行。
建立 SKU 对应关系，查询实物库存、预留库存和可用库存。
准备入库计划、添加明细、申请到货时段，并跟进入库差异。
订单履约生成发运记录后，查询承运商、跟踪信息和配送状态。
基于订单发起退货申请，并附上照片或文件。
通过集成查询订阅和投递历史。
合作伙伴密钥
请将密钥保存在服务端。每项操作均受账户和合作伙伴权限约束；获授权的管理员在对应门户中管理密钥创建、轮换以及 Webhook 订阅。
请介绍数据流和所需操作。我们将共同确认账户访问、权限范围及适用的 SDK 软件包。