开发者文档

全面的技术文档和API参考,帮助开发者快速集成和使用活牛采购智能数字化系统。

开发者文档

文档分类

选择您需要的技术文档类型

API参考

完整的API接口说明和参数说明

查看API
SDK文档

各种编程语言的SDK使用指南

查看SDK
集成指南

系统集成和二次开发指南

查看指南

快速开始

5分钟快速接入API

1. 获取API密钥

首先需要在管理后台申请API访问密钥:

// 登录管理后台
// 进入"系统设置" → "API管理"
// 点击"创建API密钥"
// 保存生成的API Key和Secret

2. 安装SDK

选择适合您开发语言的SDK进行安装:

Node.js
npm install @niumall/sdk
Python
pip install niumall-sdk
Java
<dependency>
    <groupId>com.niumall</groupId>
    <artifactId>sdk</artifactId>
    <version>1.0.0</version>
</dependency>

3. 调用API示例

使用SDK创建采购订单:

Node.js示例
const { NiuMallClient } = require('@niumall/sdk');

const client = new NiuMallClient({
  apiKey: 'your-api-key',
  apiSecret: 'your-api-secret',
  baseUrl: 'https://wapi.nanniwan.com/v1'
});

// 创建采购订单
const order = await client.orders.create({
  supplierId: 'supplier-123',
  productType: 'beef_cattle',
  quantity: 50,
  unitPrice: 15000,
  deliveryDate: '2024-03-15'
});

console.log('订单创建成功:', order);
Python示例
from niumall import NiuMallClient

client = NiuMallClient(
    api_key='your-api-key',
    api_secret='your-api-secret',
    base_url='https://wapi.nanniwan.com/v1'
)

# 创建采购订单
order = client.orders.create({
    'supplier_id': 'supplier-123',
    'product_type': 'beef_cattle',
    'quantity': 50,
    'unit_price': 15000,
    'delivery_date': '2024-03-15'
})

print('订单创建成功:', order)

API参考

完整的API接口说明

认证方式

所有API请求都需要在请求头中包含认证信息:

Authorization: Bearer {access_token}
或者
X-API-Key: your-api-key
X-API-Secret: your-api-secret

订单管理API

POST /v1/orders

创建采购订单

请求参数
{
  "supplierId": "string",     // 供应商ID
  "productType": "string",   // 产品类型
  "quantity": "number",      // 采购数量
  "unitPrice": "number",     // 单价(元)
  "deliveryDate": "string",  // 交货日期
  "remarks": "string"        // 备注信息
}
响应示例
{
  "code": 200,
  "message": "success",
  "data": {
    "orderId": "order-123456",
    "status": "pending",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}
GET /v1/orders/{orderId}

获取订单详情

响应示例
{
  "code": 200,
  "message": "success",
  "data": {
    "orderId": "order-123456",
    "supplierId": "supplier-123",
    "productType": "beef_cattle",
    "quantity": 50,
    "unitPrice": 15000,
    "totalAmount": 750000,
    "status": "confirmed",
    "deliveryDate": "2024-03-15",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T11:00:00Z"
  }
}

供应商管理API

GET /v1/suppliers

获取供应商列表

查询参数
?page=1&limit=20&type=beef_cattle
响应示例
{
  "code": 200,
  "message": "success",
  "data": {
    "items": [
      {
        "supplierId": "supplier-123",
        "name": "某某养殖场",
        "type": "beef_cattle",
        "contact": "张经理",
        "phone": "13800138000",
        "address": "某省某市某区"
      }
    ],
    "total": 100,
    "page": 1,
    "limit": 20
  }
}

SDK文档

多种编程语言的SDK使用说明

Node.js SDK

适用于JavaScript/TypeScript开发的SDK,支持异步操作和Promise。

安装
npm install @niumall/sdk
基本用法
const { NiuMallClient } = require('@niumall/sdk');
const client = new NiuMallClient({ apiKey, apiSecret });
Python SDK

适用于Python开发的SDK,支持同步和异步请求。

安装
pip install niumall-sdk
基本用法
from niumall import NiuMallClient
client = NiuMallClient(api_key, api_secret)
Java SDK

适用于Java开发的SDK,支持Spring Boot集成。

安装
<dependency>
  <groupId>com.niumall</groupId>
  <artifactId>sdk</artifactId>
  <version>1.0.0</version>
</dependency>
基本用法
NiuMallClient client = new NiuMallClient(apiKey, apiSecret);
PHP SDK

适用于PHP开发的SDK,支持Composer管理。

安装
composer require niumall/sdk
基本用法
$client = new NiuMallClient($apiKey, $apiSecret);

技术支持

遇到技术问题?我们的开发团队随时为您提供帮助

技术论坛

与其他开发者交流技术问题

访问论坛
邮件支持

发送邮件获取专业技术支持

发送邮件