光速总部

    分页

    页面限制

    光速API返回的对象的数量限制为最多100。请求返回的对象的数量是可以降低指定限制查询参数。

    分页

    示例请求(第一页)

    美元旋度- h“授权:无记名{访问令牌}”\“https://api.lightspeedapp.com/API/V3/Account/ {AccountID} / Item.json”

    示例响应

    {“@attributes”:{“下一个”:“https://api.lightspeedapp.com/API/V3/Account/ {AccountID} / Item.json ? = itemID&limit = 100本次= WzEwMF0 % 3 d”,“以前”:”“},“项目”:(“…”]}

    示例请求(最后一页)

    美元旋度- h“授权:无记名{访问令牌}”\“https://api.lightspeedapp.com/API/V3/Account/ {AccountID} / Item.json吗?类型= itemID&limit = 100本次= WzIwMF0 % 3 d”

    示例响应

    {“@attributes”:{“下一个”:”“,“以前”:“https://api.lightspeedapp.com/API/V3/Account/ {AccountID} / Item.json ? = itemID&limit = 100之前= WzEwMV0 % 3 d”},“项目”:(“…”]}

    当查询大型数据集可能需要发送多个请求来检索所有数据。

    每一个得到的响应负载(查询)端点包括两个元数据属性,下一个和以前的,其中包含完整的url获取邻页面。接下来的URL将继续向前的数据集,而前面的URL会向后先前请求的页面。在一个给定的方向随意翻阅,简单地发送另一个请求提供的URL。

    如果没有可用相邻的页面在一个给定的方向,下一个之前和/或键将包含一个空字符串。在第一页的结果,前面的关键将永远是空的。最后一页的结果,接下来的关键将是空的。

    除了所有的初始请求的查询参数,下一个/以前的url总是包含后/之前分别查询参数。这些参数包含编码数据需要简历查询从先前的位置查询。分类在不同的领域可能会导致编码不同长度的字符串。我们强烈反对自己制作这些参数的值,或者复制到另一个请求的值,因为这可能会导致意想不到的结果。总是使用url提供未来/以前的钥匙。

    如果省略了从最初的请求,默认值的限制和排序参数将被附加到随后的url,以确保一致性的行为。

    排序

    默认情况下,大多数端点将返回记录命令的主要实体的ID在升序排序的问题。

    每个端点可能提供可用于一个或多个字段排序的排序查询参数。这通常包括主ID和时间戳字段。一些端点允许其他领域。试图将导致一个不受支持的字段进行排序返回一个错误。这个错误将列表允许端点排序参数。

    降序排列可以通过将一个使用- - - - - -(-)字符字段名的开始。

    示例请求(默认——主ID提升)

    美元旋度- h“授权:无记名{访问令牌}”\“https://api.lightspeedapp.com/API/V3/Account/ {AccountID} / Item.json”

    示例请求(主ID降序)

    美元旋度- h“授权:无记名{访问令牌}”\“https://api.lightspeedapp.com/API/V3/Account/ {AccountID} / Item.json ? = itemid”

    示例请求(时间戳提升)

    美元旋度- h“授权:无记名{访问令牌}”\“https://api.lightspeedapp.com/API/V3/Account/ {AccountID} / Item.json ? =时间戳”

    示例请求时间戳(降序)

    美元旋度- h“授权:无记名{访问令牌}”\“https://api.lightspeedapp.com/API/V3/Account/ {AccountID} / Item.json ? =时间戳”

    计数

    可以检索的总数可用的结果通过发送一个单独的请求数= 1查询参数。这个参数会导致没有记录返回,但响应将包含一个元数据数属性与一个整数值记录的总数与搜索条件匹配的所有页面。

    结合数= 1与任何分页和排序查询参数查询参数将导致返回一个错误。不兼容的参数列表包括:限制,下一个,以前的,排序。

    使用数= 1查询参数会导致请求花费相同数量的滴作为一个写操作(10)。建议检索数量很少,和缓存值适合于您的应用程序。看到速度限制为更多的信息。

    V2分页

    支持V2的API将停止5月1日,2023年。我们强烈建议升级你的集成。

    旧版本的API的使用抵消参数指定应该如何跳过许多记录。例如,?限制= 100将返回第一页,?限制= 100抵消= 100将返回第二页,?限制= 100抵消= 200将返回第三页,等等。

    抵消分页不能很好地扩展到更大的数据集相比,第三版中引入的基于指针的方法后和之前查询参数,导致明显慢响应时间,尤其是在更大的数据集。因此,我们强烈建议使用最新版本的API。

    Baidu
    map