​​​​​​​使用 DMM Web API 获取搜索列表数据

5 阅读4分钟

 DMM 平台提供了丰富的 Web API 接口,允许开发者获取其平台上的各种数据。其中一个常用的接口是用于获取搜索列表结果的 API。本文将介绍如何调用此 API 来获取商品或内容的列表信息。

一、 API 概述

该搜索列表 API 允许你根据指定的搜索条件(如关键词、类别、排序方式等)查询 DMM 平台上的商品或内容,并以结构化的数据格式(通常是 JSON 或 XML)返回匹配的结果列表。

二、 准备工作

  1. 获取 API ID 和 Affiliate ID:

    • 你需要在 DMM 的开发者门户网站注册并申请 API 访问权限。
    • 申请通过后,你将获得一个唯一的 API ID 和一个 Affiliate ID (也称为 CID)。这些是调用 API 进行身份验证所必需的。
  2. 选择服务类型和输出格式:

    • DMM API 通常按服务类型分类(例如,视频、游戏、电子书等)。你需要确定你要查询的是哪个服务领域。
    • API 支持不同的输出格式,如 JSONXML。你需要根据你的开发环境选择一种格式(本文以 JSON 为例)。

三、 构造 API 请求 URL

API 请求通过 HTTP GET 方法发送。URL 由基础地址、服务类型标识、API ID、Affiliate ID 以及一系列查询参数组成。基本结构如下:

https://api.dmm.com/affiliate/v3/[ServiceType]?api_id=YOUR_API_ID&affiliate_id=YOUR_AFFILIATE_ID&[QueryParameters]

  • [ServiceType]: 替换为具体的服务类型标识符,例如 ItemList 可能用于通用商品列表搜索,但 DMM 有更具体的分类(如 ActressSearch 用于演员搜索,FloorList 用于楼层信息等,请务必查阅官方文档确定你要用的服务类型)。对于一般的商品搜索,常见的是 ItemList 或特定类别的服务。

  • YOUR_API_ID: 替换为你申请到的实际 API ID。

  • YOUR_AFFILIATE_ID: 替换为你申请到的实际 Affiliate ID。

  • [QueryParameters]: 用于指定搜索条件的参数,常见的包括:

    • keyword=搜索关键词 (URL 编码)
    • floor_id=楼层ID (特定类别)
    • hits=返回结果数量
    • offset=结果偏移量 (用于分页)
    • sort=排序方式 (如 rank, date, review)
    • output=json (指定输出格式为 JSON)

四、 请求示例 (Python)

以下是一个使用 Python 的 requests 库调用 API 的简单示例:

import requests
import urllib.parse

# 替换为你的实际 ID
api_id = "YOUR_API_ID"
affiliate_id = "YOUR_AFFILIATE_ID"

# 基础 URL (假设服务类型为 ItemList)
base_url = "https://api.dmm.com/affiliate/v3/ItemList"

# 构造查询参数
params = {
    "api_id": api_id,
    "affiliate_id": affiliate_id,
    "keyword": urllib.parse.quote("アイドル"),  # 对关键词进行 URL 编码
    "hits": 10,  # 获取 10 条结果
    "offset": 0,  # 从第一条开始
    "sort": "date",  # 按日期排序
    "output": "json"  # 指定 JSON 输出
}

# 发送 GET 请求
response = requests.get(base_url, params=params)

# 检查响应状态
if response.status_code == 200:
    # 解析 JSON 响应
    data = response.json()
    # 处理返回的数据 (data)
    print(data)  # 示例:打印整个响应
else:
    print(f"请求失败,状态码: {response.status_code}")
    print(response.text)  # 打印错误信息

五、 处理响应数据

成功的响应(状态码 200)将返回一个 JSON 对象。其结构通常包含一个 result 对象,里面存放着实际的数据。

{
  "result": {
    "status": "OK",
    "message": "...",
    "result_count": 10,
    "total_count": 100,
    "items": [
      {
        "service_code": "...",
        "service_name": "...",
        "floor_code": "...",
        "floor_name": "...",
        "content_id": "...",
        "title": "...",
        "URL": "...",
        "affiliateURL": "...",
        "sampleImageURL": { "small": "...", "large": "..." },
        "prices": { "price": "...", "deliveries": { ... } },
        "date": "...",
        "iteminfo": { ... }
      },
      // ... 更多商品项
    ]
  }
}

关键字段解释(具体字段可能因服务类型略有不同):

  • result.status: 请求状态,通常为 "OK" 表示成功。
  • result.result_count: 本次返回的结果数量。
  • result.total_count: 符合条件的结果总数(用于分页计算)。
  • result.items: 包含商品/内容详细信息的数组。
  • items[].content_id: 内容的唯一标识符。
  • items[].title: 内容标题。
  • items[].URL: 内容在 DMM 上的原始 URL。
  • items[].affiliateURL: 包含你的 Affiliate ID 的推广链接(用于推广)。
  • items[].sampleImageURL: 示例图片 URL (不同尺寸)。
  • items[].prices: 价格信息。
  • items[].date: 发布日期。

六、 注意事项

  1. 身份验证: 必须提供正确的 api_idaffiliate_id
  2. 编码: 搜索关键词等包含非 ASCII 字符的参数需要进行 URL 编码。
  3. 分页: 使用 offsethits 参数实现分页。offset 表示跳过的记录数,hits 表示本次请求获取的记录数。total_count 可用于计算总页数。
  4. 速率限制: DMM API 可能有调用频率限制,请查阅官方文档并遵守规定。
  5. 错误处理: 务必检查 HTTP 状态码和响应 JSON 中的 status 字段,以处理可能的错误(如无效参数、认证失败、超过限制等)。
  6. 官方文档: API 的具体参数、服务类型标识符、响应字段定义等细节,请务必以 DMM Affiliate (A8) 的官方开发者文档 为准,因为接口可能会更新。

七、 总结

通过调用 DMM 提供的搜索列表 API,开发者可以方便地获取平台上的商品或内容信息,用于构建自己的应用、进行数据分析或创建推广链接。关键在于正确构造包含认证信息和查询参数的请求 URL,并妥善解析返回的 JSON 数据。记得始终参考最新的官方文档进行开发。