一、API接口核心信息
1. 接口名称与用途
- 接口名称:
item_get
(商品详情获取接口) - 主要用途:通过商品ID(
num_iid
)获取1688平台上商品的详细信息,包括基础属性、价格体系、库存状态、图片描述及商家详情等。
2. 请求参数
- 必填参数:
key
:调用key,需以GET方式拼接在URL中。secret
:调用密钥。api_name
:API接口名称,此处为item_get
。num_iid
:商品ID,用于指定获取哪个商品的详情信息。
- 可选参数:
cache
:是否使用缓存数据,默认为yes
。result_type
:返回数据格式,默认为json
。lang
:翻译语言,默认为cn
(简体中文)。version
:API版本。sales_data
:设为1时可获取近30天成交数据。agent
:设为1时可获取1688分销代发价格数据。
3. 返回数据
- 成功调用接口后,将收到一个包含商品详情的JSON响应,响应中包含的字段与请求参数中
fields
指定的字段相对应。 - 常见返回字段:
num_iid
:商品ID。title
:商品名称。price
:商品价格。total_price
:商品总价。original_price
:原价。nick
:卖家昵称。num
:商品库存数量。detail_url
:商品详情页的URL。pic_url
:商品图片的URL。brand
:品牌名称。brandid
:品牌ID。rootcatid
:根类目ID。cid
:类目ID。desc
:商品详细描述。item_imgs
:商品图片列表。props_name
:商品属性名称。prop_imgs
:属性图片。property_alias
:属性别名。props
:商品属性列表。sku_list
:SKU信息列表,包含SKU ID、价格、库存等。supplier
:供应商信息对象,包括供应商ID、名称、联系人、电话、邮箱等。
二、API接口申请流程
1. 注册开发者账号
- 访问1688开放平台,进行开发者账号的注册。
- 填写相关信息,包括个人信息和企业信息(如适用),并提交审核。
2. 创建应用并获取API密钥
- 审核通过后,登录开发者账号,在开放平台创建应用。
- 为应用配置相关权限,特别是访问店铺商品信息的权限。
- 获取应用的API密钥(
app_key
和secret
),这些密钥将用于后续的API调用和身份验证。
3. 查阅API文档并调用API接口
- 详细阅读1688开放平台提供的1688开放平台API文档,了解接口说明、请求参数、响应格式等关键信息。
- 使用合适的编程语言(如Python、Java等)编写代码,通过HTTP请求调用API接口。
三、Python请求示例
以下是一个使用Python调用1688商品详情API的完整示例代码:
python
# coding:utf-8 |
""" |
Compatible for python2.x and python3.x |
requirement: pip install requests |
""" |
from __future__ import print_function |
import requests |
# 配置参数 |
API_URL = "https://api-gw.onebound.cn/1688/item_get/" |
app_key = "YOUR_APP_KEY" # 替换为实际获取的app_key |
secret = "YOUR_APP_SECRET" # 替换为实际获取的secret |
num_iid = "610947572360" # 替换为实际商品ID |
# 构建请求参数 |
params = { |
"key": app_key, |
"secret": secret, |
"api_name": "item_get", |
"num_iid": num_iid, |
"cache": "yes", |
"result_type": "json", |
"lang": "cn", |
"version": "1.0" |
} |
# 发送GET请求 |
response = requests.get(API_URL, params=params) |
# 解析响应数据 |
if response.status_code == 200: |
json_obj = response.json() |
print(json_obj) |
else: |
print(f"请求失败,状态码:{response.status_code}") |
四、注意事项
1. API调用限制
- 每日调用限额为5000次,需注意调用频率,避免超出限额。
- 需处理分页逻辑(通过
pageNo
循环请求),以获取全部数据。
2. 数据安全与合规性
- 妥善保管API密钥(
app_key
和secret
),避免泄露。 - 确保接口调用合法合规,避免滥用权限。
3. 数据准确性与稳定性
- 接口返回数据可能存在更新延迟,需结合业务需求进行数据验证。
- API可能因服务器维护或网络问题出现不稳定,需做好错误处理和重试机制。
通过以上步骤和示例代码,您可以快速上手并调用1688商品详情API接口,获取所需的商品信息。