api, speedrun.com的REST API 文档

分享于 

3分钟阅读

GitHub

  繁體 雙語
REST API Documentation for speedrun.com
  • 源代码名称:api
  • 源代码网址:http://www.github.com/speedruncomorg/api
  • api源代码文档
  • api源代码下载
  • Git URL:
    git://www.github.com/speedruncomorg/api.git
    Git Clone代码到本地:
    git clone http://www.github.com/speedruncomorg/api
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/speedruncomorg/api
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    speedrun.com REST API

    我们为我们提供了一个简单的基于json的REST API 来访问我们的大部分关于游戏。运行和玩家的数据。 这个API是一个在纯REST和真实世界之间的良好折衷。

    如果要使用 API,你应该熟悉HTTP和JSON的工作方式。 记录这些基本内容超出了本文档的范围。

    基本

    大多数API只读 read read匿名,你不需要任何凭证或者权限访问 API。 我们根据需要为每个用户添加对写操作的支持。 在这些情况下,API客户机需要使用用户密钥( 每个用户都有一个,如果你想代表其他用户做东西,他们需要给你的应用程序提供API密钥)的API进行身份验证。 有关更多信息,请参见身份验证插件。

    所有对API的请求都受速率限制限制。

    API被版本化,版本反映在你使用的URL中。 API root, https://www.speedrun.com/api 插件将把你重定向到当前版本。 我们承诺尽最大努力永远不会破坏我们的API ( 有时我们用新的信息扩展当前的API,但是我们不会改变现有的) 发布版本。

    如有可能,请设置描述性 User-Agent HTTP头。 这使得我们更容易看到如何使用API并进一步优化它。 好的User Agent 字符串包括项目 NAME 和可能的版本号,如 my-bot/4.20

    版本

    插件实现

    然而,下面的实现不是官方API的一部分。 对于任何 Bug 等等,请联系他们各自的创建者。

    • SpeedrunComSharp 一个可以用于与 speedrun.com API交互的.NET 库。
    • srapi - 一个相对裸的API客户端编写。
    • srcomapi - python 库。
    • Speedrun4J - 一个Java库( 它还没有所有属性的getter )。

    内容许可证

    网站一样,通过API提供的所有原始内容都是在 CC-BY-NC 4.0下许可的。 图片和视频是他们各自所有者的版权。

    如果这对你不适用,我们可以联系我们,我们可以找到解决方法。


    COM  API  DOC  REST  speed  Api Doc  
    相关文章