跳到主要内容

平台API介绍

API（ApplicationProgramming Interface, 应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。用户使用 规定的格式调用 API 即可获取相应信息。

平台目前支持的API有以下2个模块:

1、组织相关的接口​

您可以在组织管理 - 集成 - 其他 - 开放接口中查看组织密钥和接口文档。组织授权开放接口主要是组织相关的人员部门、汇报关系、日志、待办等数据接口。

文档地址为：https://apidoc.mingdao.com

2、应用工作表接口​

每个应用创建后，会自动创建对应的API接口，应用管理员可查看接口文档，也可以将接口文档分享给开发者。

文档查看入口：点击应用名称右侧按钮，然后点选"API开发文档"。

具体接口列表如下：

  • 应用

    • 获取应用信息 GET

  • 表

    • 新建工作表 POST
    • 获取工作表结构信息 POST

  • 记录

    • 获取列表 POST
    • 新建行记录 POST
    • 批量新建行记录 POST
    • 获取行记录详情 GET
    • 获取行记录详情 POST
    • 更新行记录详情 POST
    • 批量更新行记录详情 POST
    • 删除行记录 POST
    • 获取关联记录 POST
    • 获取记录分享链接 POST
    • 获取工作表总行数 POST
    • 获取行记录日志 POST

  • 应用角色

    • 获取应用角色列表 GET
    • 创建应用角色 POST
    • 删除应用角色 POST
    • 添加应用角色成员 POST
    • 移除应用角色成员 POST
    • 退出应用 POST

分享应用API接口​

有时非应用的成员也需要查看应用API，例如将本应用和外部应用做对接的实际开发者，此时可以将应用API文档分享出去。

应用管理员进入"应用管理"菜单 ，然后选择"API开发文档" 打开本应用的API接口页面，在页面右上角点击分享按钮进行分享。

  • 在分享的API接口页面中，所有有关密钥信息不会显示，用到密钥信息的示例中会展示为“YOUR_APP_KEY”、YOUR_SIGN”。
  • 分享时可以设置链接有效期和密码访问。

API调用限流与限制​

  • API调用限制

    目前只对同一IP的调用频率做限制，不对某个应用或某个用户做限制。超过调用频率限制和请求体大小限制将禁止调用。

    接口单个IP的QPS（每秒请求数）请求体大小限制
    新建行记录（addRow）5016MB
    批量新增行记录（addRows）5016MB
    编辑行记录（editRow）5016MB
    批量编辑行记录（editRows）5016MB
    删除行记录（deleteRow）5016MB
    获取记录数量（getFilterRowsTotalNum）50/
    获取记录列表（getFilterRows）50/
    其他接口不限制/
    私有部署不限制25MB
    ⚠️⚠️⚠️

    1.同一个IP超过调用频率限制，API网关层返回HTTP状态码 503：同时返回结构：{"error_code":90001,"success":false,"error_msg":"调用接口超出限制"}.

    如果遇到这个错误，可以考虑以下方法：

    • 为了业务健壮性，加入针对此类错误码的处理，可以加入重试机制

    • 可以在请求里面加入时间间隔，特别是循环请求体里面，如Sleep(200ms)

    2.超过请求体大小的限制，将直接拒绝服务，API网关层返回HTTP状态码 413：Request Entity Too Large.

    如果您需要处理更大的数据负载，可以考虑以下方法：

    • 数据拆分：​将大的数据集拆分成多个较小的部分，分别发送
    • 优化数据结构：​移除不必要的字段，压缩数据结构，以减少请求体的大小