自行车指数API V3

自行车索引是开源的。你可以在GitHub上查看源代码- API在app / controllers / api / v3测试结果出来了规范/要求/ api / v3．

如果您在这里(或自行车索引的任何地方)遇到任何错误，请在GitHub上提交一个问题．

如果您有问题，请联系admin@www.cdn3888.com．

本文档显示演示请求中的端口号。www.cdn3888.com:443/ api / v3 /搜索．虽然这是有效的，但这是不必要的。您可以删除: 443——例如www.cdn3888.com/api/v3/search。

本文档在IE中没有经过测试或支持，我们建议您使用不同的浏览器

简介

自行车索引API是围绕REST组织的。我们的API设计为具有可预测的、面向资源的url，并使用HTTP响应代码来指示API错误。JSON将在API的所有响应中返回，包括错误。

歌珥

Bike Index API上的每个端点都支持跨来源资源共享(CORS)。

CORS规范允许web应用程序进行跨域AJAX调用，而无需使用JSONP等变通方法。有关CORS的更多信息，请阅读这篇文章,或规范．

错误

Bike Index使用HTTP响应代码来指示API请求的成功或失败。一般来说，2xx范围内的代码表示成功，4xx范围内的代码表示由所提供的信息导致的错误(例如，缺少必要的参数，充电失败等)，5xx范围内的代码表示我们的服务器发生了错误。

错误响应为一个JSON对象，该对象在键下有错误描述错误如。{"error":"无法找到id=XXXXXX的自行车"}．

“自行车”这个词

我们在整个文档中使用工作“自行车”来表示任何已注册的东西(无论是双人自行车、冰淇淋车还是标准自行车)。如果我们专门指的是标准自行车，我们会注意到这一点。

您可以查看我们接受的所有类型的周期。

自行车的url

自行车索引的HTML页面遵循与API相同的模式——自行车的url是//www.cdn3888.com/bikes/{bike_id}。

时间

自行车索引API V3显示一切在UTC unix时间戳(整数)。您发送的所有时间参数也都需要使用时间戳。

身份验证

自行车索引使用OAuth2。创建一个应用程序并对任何需要授权的请求使用访问令牌。

有红星的终结点(＊)需要使用一个访问令牌。

对于未经身份验证的请求有更高的速率限制—在所有请求中包含一个访问令牌(即使不需要)是一个好主意。