自行车指数API V3

自行车指数是开源的。你可以查看github上的源代码- API正在进行中app / controllers / api / v3和它的测试是在规格/ api / v3。

如果您在此处遇到任何错误（或自行车指数的任何位置），请在GitHub上提交问题。

如果您有疑问联系admin@www.cdn3888.com.。

本文档显示演示请求中的端口号 - 例如BikeIndex.org：443./ API / V3 /搜索。虽然这是有效的，但它是不必要的。你可以删除：443- 例如BikeIndex.org/api/v3/Search。

在IE中未测试或支持此文档，我们建议您使用不同的浏览器

介绍

自行车指数API围绕休息组织。我们的API旨在具有可预测的资源为导向的URL，并使用HTTP响应代码来指示API错误。JSON将在API的所有响应中返回，包括错误。

结束

Bike Index API上的每个端点都支持跨原点资源共享（CORS）。

CORS规范允许Web应用程序在不使用JSONP等工作场所的情况下使交叉域Ajax调用。有关CORS的更多信息，请阅读本文， 或者规范。

错误

自行车索引使用HTTP响应代码来指示API请求的成功或失败。通常，2xx范围中的代码表示成功，4xx范围中的代码表示由提供的信息（例如缺少所需参数，电荷失败等）导致的错误，并且5xx范围中的代码表示错误与我们的服务器。

错误使用JSON对象进行响应，并在密钥下的错误描述错误例如{“错误”：“无法找到id = xxxxxx的自行车”}。

“自行车”这个词

我们在本文档中使用工作“自行车”表示注册的任何内容（成为串联，冰淇淋推车或标准自行车）。如果我们专门提及标准自行车，请注意。

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

自行车网址

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

时间

自行车索引API V3显示所有内容UTC UNIX时间戳（整数）。您发送的所有时间参数也需要使用时间戳。

验证

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

终点与红星（*）要求访问令牌使用。

对未经身份验证的请求增加了速率限制 - 包括所有请求中的访问令牌（即使不需要）是一个好主意。