obelisk-card-sdk

方尖碑发卡系统供应商API SDK - Node.js

安装

方式1：直接使用文件（推荐）

下载 SDK 压缩包并解压后，直接使用：

const ObeliskCardSDK = require('./index.js');

方式2：本地安装

在项目目录下：

npm install ./path/to/sdk

或者将 SDK 文件复制到项目中，然后在 package.json 中添加：

{
  "dependencies": {
    "obelisk-card-sdk": "file:./path/to/sdk"
  }
}

然后运行：

npm install

方式3：从 npm 安装（推荐）✅

npm install obelisk-card-sdk

✅ SDK 已发布到 npm！ 您可以直接使用 npm 安装。

查看包信息：https://www.npmjs.com/package/obelisk-card-sdk

方式4：安装依赖

SDK 需要以下依赖：

npm install axios

注意：crypto 是 Node.js 内置模块，无需安装。

快速开始

const ObeliskCardSDK = require('obelisk-card-sdk');

// 初始化SDK
const sdk = new ObeliskCardSDK({
  apiKey: 'YOUR_API_KEY',
  apiSecret: 'YOUR_API_SECRET',
  baseUrl: 'https://api.example.com'
});

// 获取商品分类列表
async function example() {
  try {
    const groups = await sdk.getGroups();
    console.log('分类列表:', groups);
    
    // 获取商品列表
    const products = await sdk.getProducts({ groupId: 1, page: 1, limit: 20 });
    console.log('商品列表:', products);
    
    // 采购商品
    const order = await sdk.purchaseProduct({
      productId: 1,
      quantity: 1,
      externalOrderSn: 'ORDER_123456'
    });
    console.log('订单信息:', order);
  } catch (error) {
    console.error('错误:', error.message);
  }
}

example();

API 方法

getGroups(params)

获取商品分类列表

参数：

• params.page (number, 可选) - 页码
• params.limit (number, 可选) - 每页数量

返回： Promise<{ groups: Array }>

getProducts(params)

获取商品列表

参数：

• params.groupId (number, 可选) - 分类ID
• params.page (number, 可选) - 页码
• params.limit (number, 可选) - 每页数量

返回： Promise<{ products: Array, total: number, page: number, limit: number }>

batchGetProducts(data)

批量获取商品

参数：

• data.products (Array<{productId: number, groupId?: number}>) - 商品查询列表（最多100个），每个元素包含productId（必需）和可选的groupId

返回： Promise<{ products: Array }>

getBalance(params)

查询余额

参数：

• params.currency (string, 可选) - 显示货币（如：USDT、CNY）

返回： Promise<{ balance: number, currency: string }>

purchaseProduct(data)

采购商品

参数：

• data.productId (number) - 商品ID
• data.quantity (number) - 购买数量
• data.externalOrderSn (string, 可选) - 外部订单号

返回： Promise<{ orderSn: string, status: string, carmis: Array<string> }>

getOrder(orderSn)

查询订单

参数：

• orderSn (string) - 订单号（系统订单号或外部订单号）

返回： Promise<{ orderSn: string, status: string, carmis: Array<string> }>

getOrders(params)

获取订单列表

参数：

• params.page (number, 可选) - 页码
• params.limit (number, 可选) - 每页数量
• params.status (number, 可选) - 订单状态

返回： Promise<{ orders: Array, total: number, page: number, limit: number }>

错误处理

所有方法在请求失败时会抛出错误，请使用 try-catch 捕获：

try {
  const result = await sdk.getProducts();
} catch (error) {
  console.error('请求失败:', error.message);
}

许可证

MIT