FOSSBilling API 参考

本文介绍了构成官方 FOSSBilling API 的资源。

API 端点

FOSSBilling 提供3 个主要API 端点：

  • example.com/api/admin/*: 管理端点。经过身份验证的管理员可以访问此端点。
  • example.com/api/client/*: 客户端端点。经过身份验证的客户端可以访问此端点。
  • example.com/api/guest/*: 管理端点。任何人都可以访问这个，即使没有经过身份验证。

Schema

默认情况下，FOSSBilling 只允许 HTTPS 连接。这可以在 config.php 中覆盖，但我们强烈不鼓励这样做。

  • 所有请求都是通过 POST 方法提出的
  • 所有数据都以 JSON 的身份发送和接收。
  • 所有方法名称均为小写，单词用下划线分隔。
  • 空白字段包含为空字段，而不是被省略。
  • 所有时间戳均以 ISO 8601 格式返回。

鉴定

  • 用户名是 admin 或 client
  • 身份验证密码是一个 API 密钥，可以从 FOSSBilling 管理区域的配置文件中检索。
  • API 使用cookie 来存储会话。
  • 身份验证凭据应通过 HTTP 授权标头提供，并进行 base64 编码。
    • 示例：如果您想访问 Admin API 端点，您必须将 admin 作为 HTTP 身份验证用户名发送，并提供您的 API 密钥作为 HTTP 身份验证密码。

请求

  • 所有请求均通过 POST 方法提出。
  • 数据可以作为 JSON 字符串或 POST 形式发送。
  • 所有数据均以 JSON 接收。