×

虾皮 item_search 接口对接全攻略:从入门到精通

万邦科技Lex 万邦科技Lex 发表于2025-10-07 14:11:54 浏览214 评论0

抢沙发发表评论

      注册账号免费测试虾皮API数据接口

虾皮(Shopee)开放平台的item_search接口是根据关键词搜索商品列表的核心工具,适用于跨境电商选品、市场分析、多平台比价等场景。本文将全面讲解该接口的对接流程、参数配置、代码实现及最佳实践,帮助开发者系统掌握从入门到精通的全流程。

一、接口基础认知

  1. 核心功能item_search接口通过关键词、分类、价格区间等条件筛选虾皮平台的商品,返回符合条件的商品列表及基础信息,包括:
    • 商品基本信息:ID、标题、主图、详情页链接

    • 价格信息:售价、原价、折扣、货币单位

    • 交易信息:销量、评分、评论数

    • 店铺信息:店铺 ID、店铺名称

    • 区域信息:商品所属站点、物流方式

  2. 接口端点虾皮搜索接口需区分区域站点,格式为:https://{region}.api.shopee.com/api/v2/search_items/常见区域代码:
    • 新加坡:sg

    • 马来西亚:my

    • 泰国:th

    • 印度尼西亚:id

    • 台湾地区:tw

  3. 请求方式:HTTP GET
  4. 数据格式:响应为 JSON 格式
  5. 认证方式:采用partner_id+access_token+ 签名认证(部分公开数据可无需access_token

二、对接前置准备

  1. 开发者账号注册访问虾皮开放平台注册账号,完成企业认证(个人账号可访问公开数据,权限有限)。
  2. 创建应用与获取密钥
    • 在开放平台控制台创建应用,选择目标市场(如东南亚、台湾)

    • 应用创建后,获取partner_idpartner_key(密钥需严格保密)

    • 如需访问店铺私有数据,需完成店铺授权获取access_token

  3. 权限说明
    • 公开商品搜索无需特殊权限,默认开放调用

    • 如需获取更多字段或提高调用频率,需申请权限升级

  4. 环境准备
    • 开发语言:支持 Python/Java/PHP 等任意可发起 HTTP 请求的语言

    • 测试工具:Postman 或虾皮开放平台调试工具

    • 依赖库:Python 需安装requests库(pip install requests

三、接口调用流程

  1. 参数组装接口参数分为「公共参数」和「业务参数」:
    示例参数结构:
    plaintext
    {
      "partner_id": 123456,
      "timestamp": 1620000000,
      "sign": "签名值",
      "keyword": "phone case",
      "page": 1,
      "limit": 20,
      "price_min": 100000,  # 1.00货币单位(以1e-5为单位)
      "price_max": 5000000   # 50.00货币单位
    }
    • 公共参数partner_idtimestamp(秒级时间戳)、sign(签名)、access_token(可选)

    • 业务参数keyword(搜索关键词,必填)、page(页码)、limit(每页条数)、price_min/price_max(价格区间)等

  2. 签名生成签名生成步骤与item_get接口一致:
    1. 收集所有参数(除sign外),按参数名 ASCII 码升序排序

    2. 拼接为key=value格式的字符串(如keyword=phone&page=1

    3. 在拼接字符串前添加partner_key

    4. 对完整字符串进行 SHA256 加密,结果即为sign

  3. 发送请求将参数以 URL 查询字符串形式拼接,发送 GET 请求到对应区域的接口地址。
  4. 响应处理成功响应包含items(商品列表)和total_count(总条数),错误响应包含error字段(错误码和描述)。

四、代码实现示例(Python)

以下是调用虾皮item_search接口的完整代码,包含签名生成、多区域支持和分页处理:
import requests
import hashlib
import time
import json

class ShopeeSearchApi:
    def __init__(self, partner_id, partner_key, access_token=None, region="sg"):
        self.partner_id = partner_id
        self.partner_key = partner_key
        self.access_token = access_token  # 可选,公开搜索可无需
        self.region = region  # 区域代码:sg/my/th/id/tw等
        self.base_url = f"https://{region}.api.shopee.com/api/v2/search_items/"

    def generate_sign(self, params):
        """生成签名"""
        # 1. 按参数名ASCII升序排序
        sorted_params = sorted(params.items(), key=lambda x: x[0])
        # 2. 拼接为key=value格式
        sign_str = "".join([f"{k}={v}" for k, v in sorted_params])
        # 3. 前缀添加partner_key
        sign_str = self.partner_key + sign_str
        # 4. SHA256加密
        sign = hashlib.sha256(sign_str.encode()).hexdigest()
        return sign

    def item_search(self, keyword, page=1, limit=20, **kwargs):
        """
        搜索商品列表
        :param keyword: 搜索关键词(必填)
        :param page: 页码,默认1
        :param limit: 每页条数,默认20,最大100
        :param kwargs: 可选参数(price_min, price_max, sort_by等)
        :return: 搜索结果
        """
        # 1. 组装基础参数
        params = {
            "partner_id": self.partner_id,
            "timestamp": int(time.time()),  # 秒级时间戳
            "keyword": keyword,
            "page": page,
            "limit": limit
        }
        
        # 2. 添加可选参数
        if self.access_token:
            params["access_token"] = self.access_token
        params.update(kwargs)

        # 3. 生成签名
        params["sign"] = self.generate_sign(params)

        try:
            # 4. 发送GET请求
            response = requests.get(
                url=self.base_url,
                params=params,
                timeout=15
            )
            response.raise_for_status()
            result = response.json()

            # 5. 处理响应
            if "error" in result and result["error"] != 0:
                return {
                    "success": False,
                    "error_code": result["error"],
                    "error_msg": result.get("message", "未知错误")
                }

            return {
                "success": True,
                "total_count": result.get("total_count", 0),
                "page": page,
                "limit": limit,
                "items": result.get("items", [])
            }

        except Exception as e:
            return {
                "success": False,
                "error_msg": f"请求异常: {str(e)}"
            }

# 使用示例
if __name__ == "__main__":
    # 替换为实际参数
    PARTNER_ID = 123456  # 开发者ID
    PARTNER_KEY = "your_partner_key"  # 开发者密钥
    ACCESS_TOKEN = None  # 公开搜索可无需
    REGION = "sg"  # 目标区域

    # 初始化API客户端
    api = ShopeeSearchApi(PARTNER_ID, PARTNER_KEY, ACCESS_TOKEN, REGION)

    # 搜索"phone case",第1页,20条/页,价格1-50新元,按销量降序
    result = api.item_search(
        keyword="phone case",
        page=1,
        limit=20,
        price_min=100000,  # 1.00新元(1e-5单位)
        price_max=5000000,  # 50.00新元
        sort_by="sales"  # 排序方式:sales-销量,price-价格,newest-最新
    )

    if result["success"]:
        print(f"共搜索到 {result['total_count']} 个商品")
        print(f"第 {result['page']} 页,当前页 {len(result['items'])} 个商品")
        
        # 打印前5个商品信息
        for i, item in enumerate(result["items"][:5]):
            print(f"\n商品 {i+1}:")
            print(f"ID: {item.get('itemid')}")
            print(f"标题: {item.get('name')}")
            print(f"售价: {item.get('price')/100000} {item.get('currency')}")
            print(f"销量: {item.get('historical_sold')}")
            print(f"店铺: {item.get('shopid')}")
            print(f"主图: {item.get('image')}")
    else:
        print(f"搜索失败: {result['error_msg']} (错误码: {result.get('error_code')})")

五、参数详解与高级用法

  1. 核心参数说明
    • relevance:相关度(默认)

    • price:价格(升序,加_desc为降序)

    • sales:销量(降序)

    • newest:最新上架(降序)

    • keyword:搜索关键词(必填),支持多语言(如英文、东南亚语言)

    • page:页码,默认 1,最大支持 100 页

    • limit:每页条数,默认 20,最大 100

    • price_min/price_max:价格区间(单位:1e-5 货币单位,如 100000=1.00)

    • sort_by:排序方式:

    • categoryids:分类 ID,可通过分类接口获取特定分类下的商品

  2. 价格单位转换虾皮价格以1e-5为单位,需转换为实际货币值:
    python
    运行
    # 转换价格示例(1500000 = 15.00货币单位)price = item.get('price') / 100000
  3. 多区域搜索策略如需覆盖多个区域市场,可循环调用不同区域的接口:
    python
    运行
    regions = ["sg", "my", "th"]  # 新加坡、马来西亚、泰国for region in regions:
        api = ShopeeSearchApi(PARTNER_ID, PARTNER_KEY, region=region)
        result = api.item_search(keyword="phone case")
        # 处理区域数据

六、错误处理与调试

  1. 常见错误码解析
    • 1001:签名错误 → 检查参数排序和签名生成逻辑

    • 1004:参数错误 → 确认keyword不为空,limit不超过 100

    • 4001:请求频率超限 → 虾皮默认 QPS 限制为 100,需降低频率

    • 5000:系统错误 → 建议重试,或检查区域代码是否正确

  2. 调试技巧
    • 使用虾皮开放平台的API 测试工具验证请求

    • 检查特殊字符处理(关键词含空格或特殊符号需 URL 编码)

    • 确认区域代码与搜索市场匹配(如搜索台湾商品需用tw

七、最佳实践与注意事项

  1. 跨境适配策略
    • 针对不同区域优化关键词(如东南亚市场使用英文 + 当地语言)

    • 处理货币转换(结合实时汇率接口转换为统一货币单位)

    • 考虑物流因素(筛选支持特定区域配送的商品)

  2. 性能优化
    • 合理设置limit(建议 50-100),减少接口调用次数

    • 实现本地缓存(热门关键词结果缓存 10-30 分钟)

    • 非实时场景采用异步任务批量获取数据

  3. 合规使用
    • 遵守《虾皮开放平台服务协议》,不得用于爬虫或商业竞争

    • 展示商品数据时需保留虾皮来源标识

    • 尊重知识产权,未经授权不得使用商品图片和描述

  4. 稳定性保障
    • 实现超时重试机制(最多 3 次,使用指数退避策略)

    • 监控接口调用成功率,异常时切换备用区域节点

    • 对返回数据进行格式校验,处理区域特有字段差异

通过本文的指南,开发者可以系统掌握虾皮item_search接口的对接方法和跨境场景适配技巧。在实际应用中,应重点关注多区域差异和关键词本地化,设计合理的搜索策略,平衡搜索效果、性能和合规性,构建稳定高效的跨境商品搜索功能


群贤毕至

访客