西域平台商品详情接口开发指南(含代码示例)

发布于:2025-03-27 ⋅ 阅读:(76) ⋅ 点赞:(0)

接口概述

通过商品ID获取商品详细信息(标题、价格、库存等),采用RESTful风格设计,支持HTTP GET请求,返回JSON格式数据。

点击获取key和secret

接口功能
获取商品基础信息
返回实时库存状态
支持多规格商品数据查询
请求方式
http
Copy Code
GET /api/v1/product/detail

请求参数
参数名    类型    必填    说明
itemId    string    是    商品唯一标识(如:XY123456)
apiKey    string    是    授权密钥(Header中传递)
成功响应示例
json
Copy Code
{
  "code": 200,
  "data": {
    "itemId": "XY123456",
    "title": "工业级电动扳手 XYZ-3000",
    "price": 499.00,
    "stock": 150,
    "specs": [
      {"name": "功率", "value": "650W"},
      {"name": "扭矩", "value": "380N.m"}
    ],
    "description": "适用于重型机械维护...",
    "images": [
      "https://example.com/image1.jpg",
      "https://example.com/image2.jpg"
    ]
  }
}

错误响应示例
json
Copy Code
{
  "code": 404,
  "message": "商品不存在"
}

代码实现示例
Python(使用requests库)
python
Copy Code
import requests

def get_product_detail(item_id, api_key):
    url = "https://api.xiyue.com/api/v1/product/detail"
    headers = {"apiKey": api_key}
    params = {"itemId": item_id}
    
    try:
        response = requests.get(url, headers=headers, params=params)
        response.raise_for_status()
        return response.json()
    except requests.exceptions.HTTPError as err:
        print(f"HTTP错误: {err}")
    except Exception as e:
        print(f"请求异常: {e}")

# 使用示例
product_data = get_product_detail("XY123456", "your_api_key_here")
if product_data and product_data["code"] == 200:
    print(f"商品标题:{product_data['data']['title']}")
    print(f"当前库存:{product_data['data']['stock']}")

JavaScript(使用axios)
javascript
Copy Code
const axios = require('axios');

async function fetchProductDetail(itemId, apiKey) {
  try {
    const response = await axios.get('https://api.xiyue.com/api/v1/product/detail', {
      headers: { apiKey },
      params: { itemId }
    });
    
    if (response.data.code === 200) {
      console.log(`商品标题:${response.data.data.title}`);
      console.log(`当前价格:¥${response.data.data.price}`);
    }
    return response.data;
  } catch (error) {
    console.error('请求失败:', error.response?.data || error.message);
  }
}

// 使用示例
fetchProductDetail('XY123456', 'your_api_key_here');

注意事项
必须启用HTTPS加密传输
API Key需通过请求头传递(非URL参数)
频率限制:100次/分钟
建议缓存商品基础数据,避免高频调用
接口调试建议

使用Postman测试时建议配置:

text
Copy Code
Headers:
- apiKey: [您的实际密钥]
Params:
- itemId: XY123456


通过该接口可快速集成商品数据展示到ERP、商城等系统,建议配合商品列表接口实现完整商品体系对接。


网站公告

今日签到

点亮在社区的每一天
去签到