🔌 API 开发者文档

欢迎使用知云科技 API，通过我们的接口您可以实现与ERP、进销存、协作办公等系统的数据对接

📋 接口概览

知云科技 API 采用 RESTful 设计风格，使用 HTTPS 协议进行通信，数据格式统一为 JSON。所有接口都需要进行身份认证。

基础信息

项目	说明
API 基础 URL	`https://api.zhicloudtech.com/v1`
数据格式	JSON
字符编码	UTF-8
认证方式	API Key + Timestamp + Signature

🔐 认证授权

所有 API 请求都需要在 HTTP Header 中携带认证信息。请联系您的客户经理获取 API Key 和 API Secret。

签名生成算法

String sign(String apiKey, String apiSecret, long timestamp) {
    String data = apiKey + timestamp + apiSecret;
    return sha256(data).toUpperCase();
}
        

请求 Header 示例

GET /v1/orders HTTP/1.1
Host: api.zhicloudtech.com
X-API-Key: your_api_key
X-Timestamp: 1707561600
X-Signature: YOUR_SIGNATURE
Content-Type: application/json
        

安全提示：请勿在客户端代码（如浏览器JavaScript或移动App）中硬编码 API Secret，这会导致密钥泄露。建议在服务器端调用 API。

📊 核心接口

1. 订单管理

GET/v1/orders

获取订单列表

请求参数

参数名	类型	必填	说明
page	integer	否	页码，默认1
page_size	integer	否	每页数量，默认20
status	string	否	订单状态：pending/confirmed/shipped/completed/cancelled
start_date	string	否	开始日期，格式：2024-01-01
end_date	string	否	结束日期，格式：2024-12-31

响应示例

{
    "code": 200,
    "message": "success",
    "data": {
        "total": 156,
        "page": 1,
        "page_size": 20,
        "list": [
            {
                "order_id": "ORD202402110001",
                "customer_name": "福州科技有限公司",
                "total_amount": 128000.00,
                "status": "confirmed",
                "created_at": "2024-02-11T09:30:00+08:00"
            }
        ]
    }
}
        

2. 库存查询

GET/v1/inventory

获取实时库存信息

3. 客户管理

POST/v1/customers

创建新客户

🔔 错误码说明

错误码	说明	解决方案
200	请求成功	正常
400	请求参数错误	检查请求参数格式
401	认证失败	检查API Key和签名
403	权限不足	联系管理员开通权限
404	资源不存在	检查资源ID
429	请求过于频繁	降低请求频率
500	服务器内部错误	联系技术支持

📞 技术支持

如果在 API 对接过程中遇到任何问题，可以通过以下方式获取帮助：

技术文档：访问帮助文档中心获取详细的产品使用指南
社区论坛：加入我们的 GitHub Discussions 技术社区
在线客服：通过官网右下角的智能客服获取即时帮助
邮件支持：发送邮件至 support@zhicloudtech.com
电话支持：拨打客服热线 400-888-6666（工作日 9:00-18:00）

← 返回文档首页