搜索

根据关键词搜索所有匹配的剧集信息

接口说明

此接口用于根据关键词搜索所有匹配的剧集信息。 当自动匹配失败或结果不理想时可以调用此接口,让用户手动通过关键词搜索到作品。

参数说明

  • anime:作品标题。支持通过中文、日语(含罗马音)、英语搜索,至少为2个字符。
  • tmdbId:使用 TMDB 电视剧 ID 搜索作品,如果指定此参数,将仅返回此 TMDB TV ID 的关联作品(可能有多个)。
  • tmdbIdType: 指定 tmdbId 的类型,0或不提供表示tmdbId为电视剧ID,1表示tmdbId为电影ID。
  • episode:剧集编号,默认为空。支持正整数或 C1/S1/O1 格式,将仅保留指定集数的结果;其他值将被忽略。
  • v2:提供 true 时使用新版搜索引擎。

必须提供anime和tmdbId中至少一个参数。 当同时提供anime和tmdbId参数时,会先尝试使用anime参数进行搜索,之后在搜索结果中匹配tmdbId的剧集。

参数注意事项

  • 参数可以包含空格,但空格将作为查询字符串的一部分而不是传统的“OR”查询。
  • 未提供episode参数的情况下,如果anime参数中包含空格,且空格后为数字(如“EVA 10”),此数字将被认定为是episode参数。
  • 如果参数中包含特殊字符,需要经过Url编码后才能传递。

返回值说明

接口将返回包含节目信息的列表,当结果集过大时,hasMore属性为true,这时客户端应该提示用户填写更详细的信息以缩小搜索范围。

get/api/v2/search/episodes

Request

  • Base URL: https://api.dandanplay.net
  • URL: https://api.dandanplay.net/api/v2/search/episodes
  • Auth: one of:
    • API key in header X-AppId
    • API key in header X-AppSecret
    • HTTP bearer

Query parameters

animestring nullable

作品标题。支持通过中文、日语(含罗马音)、英语搜索,至少为2个字符。

tmdbIdinteger nullable

TMDB ID,如果指定此参数,将仅返回此 TMDB ID 的关联作品(可能有多个)。

tmdbIdTypeinteger

指定 tmdbId 的类型,0或不提供表示tmdbId为电视剧ID,1表示tmdbId为电影ID。

episodestring nullable

剧集编号,默认为空。支持正整数或 C1/S1/O1 格式,将仅保留指定集数的结果。 其他值将被忽略。

v2boolean

提供 true 时使用新版搜索引擎。默认为false。

Response

errorCodeinteger

错误代码,0表示没有发生错误,非0表示有错误,详细信息会包含在errorMessage属性中

successboolean

接口是否调用成功

errorMessagestring nullable

当发生错误时,说明错误具体原因

errorDetailstring nullable

当参数校验失败时,提供可供调用方定位问题字段的补充信息。

hasMoreboolean

是否有更多未显示的搜索结果。当返回的搜索结果过多时此值为true

Changes

No recorded changes to this operation across all 1 revision of this API.