自行车索引API V3

如果您在此处遇到任何错误（或在自行车索引上的任何地方），请在GitHub上提交问题。

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

此文档在演示请求中显示端口号 - 例如www.cdn3888.com：443/api/v3/搜索。在这种情况下，这是不必要的。您可以删除：443- 例如www.cdn3888.com/api/v3/search。

IE中未对此文档进行测试或支持，建议您使用其他浏览器

介绍

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

自行车索引API上的每个端点都支持交叉原始资源共享（CORS）。

CORS规格允许Web应用程序在不使用JSONP等解决方法的情况下进行跨域Ajax调用。有关CORS的更多信息，请阅读本文，或者规格。

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

错误用JSON对象响应，并描述键下的错误错误例如{“ error”：“找不到ID = xxxxxx的自行车}。

我们在本文档中使用“自行车”的作品来表示注册的任何内容（无论是串联，冰淇淋推车还是标准自行车）。如果我们是专门指的是标准自行车，我们会注意到这一点。

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

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

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

带有红色星星的终点（*）需要使用访问令牌。

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

您没有设置任何应用程序！为了能够使用API，您需要创建应用程序并生成访问令牌。

自行车索引使用OAuth2。

通过OAuth2，有两种支持自行车索引认证的方法：

授权流使长期通过刷新令牌访问（而不是每小时登录用户），更安全，通常是您应该使用的。学习更多关于OAuth2中的授权流。

客户端流非常适合客户端JavaScript应用。这是一篇关于OAuth2中的客户端流。

非认证请求的未来将有限制的速率 - 因此，如果您有访问令牌，请考虑将其用于所有内容。

查看您已授权的申请/oauth/授权_applications。

默认情况下，我们通过标题中的身份验证对您进行身份验证。如果在授权标题中找不到身份验证，则将其返回到参数。我们建议将身份验证信息放在标题中（“授权” =>“承载＃{token}”）。

但是，本文档中的所有身份验证的请求都将访问令牌放在参数中，以清晰。

由于令牌提供了对某人帐户的访问权限，因此OAuth2确保事物安全的方式之一就是使令牌到期 - 因此，如果某人妥协访问令牌，则他们没有无限制的访问帐户。自行车索引在1小时后到期令牌。

当您的访问令牌到期时，您可以通过使用您的应用程序ID和REFRESH令牌提出发布请求来获得新的内容：

发布//www.cdn3888.com/oauth/token?grant_type = refresh_token＆client_id = {app_id}＆refresh_token = refresh_token}

该文档由Swagger.io。要了解有关Swagger的更多信息以及为什么很棒的结帐Swagger.io。

Swagger Doc URL