SmartScout API

概述

SmartScout API 是一种 REST 风格的 API，它接受并返回 JSON。

身份验证

SmartScout API 使用 API 密钥对请求进行身份验证。API 密钥必须传递到 X-Api-Key 标头，并且必须出现在所有 API 请求中。

请联系 SmartScout 支持部门索要您的 API 密钥。

市场查询字符串参数

除了 API 密钥外，所有请求还必须包含 市场 查询字符串参数。支持的值为 我们， 英国， 它， DE， 加州， MX， 法国，以及 是。

分页

端点是分页的，并使用光标分页方法。这意味着，如果回复无法带回所有物品，您将获得 下一页ID 这是指向下一组数据的指针。然后，您可以将此值设置为 页面 [id] 查询字符串参数，用于下次请求检索下一组数据。还有一个 有更多记录 响应中的属性，用于指示是否还有更多项目。如果将其设置为 true， 下一页ID 会有价值。

这些端点对返回的数据量有内置限制。但是你也可以指定 页面 [大小] 查询字符串参数，将项目限制为所需的数量。但是请注意，如果 页面 [大小] 参数超过了内置限制，它将被忽略。

排序

端点通过传递来提供排序能力 排序 [依据] 带有字段名称的查询字符串参数。您也可以通过传入来设置排序顺序 排序 [顺序] 查询字符串参数为 asc 用于升序和 降序 用于降序。

有关可用的字段名称，请查看此链接中的响应架构定义。 https://api.smartscout.com/index.html

过滤

搜索端点使您能够提供搜索过滤器。过滤器可以是简单的文本、数字、布尔值或日期。但是有些过滤器使您可以灵活地指定不同的匹配规则。大多数文本字段支持以下规则： 开始于， 包含， 不包含， endSwith， 等于， NoteQuals， 空白。另一方面，数字字段为你提供了一个选项来设置 分钟 和/或 最大 价值观。

有关可用的过滤器参数，请查看此链接中的请求架构定义。 https://api.smartscout.com/index.html

以下是一些例子：

架构和终端节点

以下链接包含终端节点列表及其相应的请求和响应架构。
https://api.smartscout.com/index.html

通常，返回的 JSON 响应将具有以下架构。

{
数据：[...]，
寻呼：{
nextPageID: 字符串，
哈斯莫尔记录：布尔值
}
}