zh
资源

API 文档

客户端站点、后台和所有平台模块通过 API 处理数据库文件,而不是直接使用。 API 控制传入数据的访问、完整性和正确性。

一般描述

API 是如何工作的?

API——平台的关键节点

本文档描述了以下操作的所有 API 方法:

  • 获取对象列表(列表方法)
  • 列表过滤(带有过滤数据的列表方法)
  • 获取有关对象的详细信息(显示方法)
  • 获取添加对象表单的数据(添加方法)
  • 将数据保存为新对象(存储方法)
  • 获取对象更新表单的数据(编辑方法)
  • 保存更新对象的数据(更新方法)

按 IP 地址检查

API 仅接受来自有限 IP 地址列表(例如,来自客户的帐户站点或后台站点)的请求。

来自不在允许列表中的 IP 地址对 API 的任何请求都将被拒绝。

这样做是为了防止对 API 的 DDoS 攻击、试图伪造请求和黑客实验。

用户始终访问平台的公共站点(客户办公室或后台),该站点本身从平台的 API 请求必要的数据。由于该站点的 IP 地址是固定的,因此它将在允许列表中。

网址和方法

所有 API 请求均使用以下 HTTP 方法发出:

  • GET 用于列表、显示、添加和编辑
  • POST 用于商店
  • PUT 更新
  • DELETE 删除

API 的每个部分都包含一个 URL,向其发出请求以获取相关数据。

每个 URL 前面都指定了 HTTP 请求方法。

发送请求

每个 API 请求必须始终包含 4 个变量:

  1. data (带有 API 数据数组的 json 字符串)
  2. user (带有当前用户数据数组的 json 字符串)
  3. time (UTC 时区的当前时间)
  4. hash (哈希形式的数字签名,用于验证对 API 的请求是否确实来自授权来源)

从 API 获取响应

如果请求成功,API 总是返回两个变量:

  1. status = true (成功状态)
  2. data (来自 API 的带有数据数组的 json 字符串)

如果请求失败,API 会显示变量:

  1. status = false (错误状态)
  2. error (描述错误的文本字符串)

电子签名

每个 API 请求都必须包含一个哈希变量,该变量是请求的数字签名。

hash = md5($json . $time . $salt)

  • md5, sha256, bcrypt — 可用的加密算法
  • $json — 带有请求数据的json字符串
  • $time — 格式为“DD.MM.YYYY HH:MM:SS”的时间
  • $salt — 固定平台 API 的唯一值(“盐”)

资源

该文档包含真实 API 请求的示例