196体育官网登陆 API 概述

这是 Simple196体育 应用程序编程接口（Rest API）的概述。该文档将概述 API 的使用、限制和政策。

在描述资源时，196体育官网使用大括号作为标识符，例如在谈论您的 Simple196体育 帐户的 URL 时使用{subdomain} ，即https://{subdomain}.simplekpi.com/api/users 。

变更政策

196体育官网保留添加到 API 的权利，恕不另行通知。现有版本的 API 可能会发生重大更改，例如删除或重命名对象属性，但需提前两周通知，任何弃用都将记录在相关部分中。主要的结构变化只会在版本更新的情况下发生。

安全和限制

此 API 仅支持 SSL，只能通过https://{subdomain}.simplekpi.com/api/ 访问。授权是使用您的用户名和帐户 API 令牌的基本身份验证。此令牌在您的 Simple196体育 帐户中可用，位于设置 |开发人员 API部分。 API 访问默认情况下处于禁用状态，必须在访问 API 之前启用。个人价格计划无法访问 API，您需要升级您的计划才能获得访问权限。

提供基本授权标头

如果需要，您可以自己构造和发送基本的身份验证标头。为此，您需要执行以下步骤：

  1. 构建一个 username:token 形式的字符串
  2. Base64编码字符串

提供一个 Authorization 标头，其内容为 Basic 后跟编码字符串，例如 Basic XZZRtaW46YARtaF8=

 curl -H "Authorization: Basic XZZRtaW46YARtaF8=" -H "Content-Type: application/json" https://{subdomain}.simplekpi.com/api/users

JSON 或 XML

此 API 将接受并返回 JSON 或 XML。为了告诉 API 您希望使用哪种内容类型，您 必须 在所有GET 、 PUT 、 POST和DELETE请求上提供Content-Type: application/json或Content-Type: application/xml标头。您还可以在请求中设置Accept: application/json或Accept: application/xml标头，但它将由Content-Type标头推断。

注意：在 Windows 上使用 cUrl 时，数据需要用引号 " 括起来并转义如下：

 curl https://{subdomain}.simplekpi.com/api/kpientries -H "Content-Type: application/json" -d "{\"user_id\": 1234, \"kpi_id\": 5678, \"entry_date \": \"2012-06-25\", \"actual\": 50, \"target\": 110, \"notes\": \"This is a note\"}" -v -u { email_address}:{token} -X POST

处理错误

如果 Simple196体育 在处理您的请求时遇到问题，您将看到 5xx 错误。 500意味着应用程序遇到了不可预见的问题或当机了，当这种情况发生时，196体育官网的支持团队将收到系统通知。您有责任稍后重试您的请求或通过support@simplekpi.com联系 simplekpi 支持。
如果您使用的是 .NET，则将在所有 4xx 和 5xx http 错误上抛出System.Net.WebException类型的异常。

速率限制

此 API 有速率限制，每分钟只允许有限数量的请求。196体育官网保留调整给定端点速率限制的权利，以便为所有客户提供高质量的服务。作为 API 使用者，您应该期望每分钟至少能够发出 200 个请求。

如果超过速率限制，您将收到一个包含HTTP 403 Forbidden响应代码的响应和一个详细说明速率限制器启动原因的正文。此外，该响应将有一个Retry-After标头，显示您有多少秒在发送您的下一个请求之前必须等待。您应该在您的 API 客户端中预料到这一点，以获得尽可能顺畅的体验。

除了默认速率限制标头之外，您还将看到：

  • X-RateLimit-Limit
  • X-RateLimit-Requests
  • X-RateLimit-Duration

主动 API 控制器

帮助196体育官网做得更好

196体育官网希望196体育官网的 API 像196体育官网的界面一样简洁明了。 Simple196体育 受欢迎的一个组成部分是倾听196体育官网的用户并将该反馈纳入未来版本。因此，请随时通过support@simplekpi.com与196体育官网联系，告诉196体育官网您的经历、挫折、建议和想法，196体育官网将努力进行这些改进。

开发者接口

友情链