跳至主要内容

平臺API介紹


API(ApplicationProgramming Interface, 應用程序編程接口)是一些預先定義的函數,目的是提供應用程序與開發人員基於某軟件的以訪問一組例程的能力,而又無需訪問源碼,或理解內部工作機製的細節。用戶使用 規定的格式調用 API 即可獲取相應信息。

平臺目前支持的API有以下2個模塊:

1、組織相關的接口

您可以在組織管理 - 集成 - 其他 - 開放接口中查看組織密鑰和接口文檔 。接口文檔主要是組織相關的人員部門、匯報關係、日誌、待辦等數據接口,隻有組織管理員可以進行查看管理。

2、應用工作錶接口

每個應用創建後,會自動創建對應的API接口,應用管理員可查看接口文檔,也可以將接口文檔分享給開發者。

文檔查看入口:點擊應用名稱右側按鈕,然後點選"API開發文檔"。

具體接口列錶如下:

  • 應用

    • 獲取應用信息 GET
    • 新建工作錶 POST
    • 獲取工作錶結構信息 POST
  • 記錄

    • 獲取列錶 POST
    • 新建行記錄 POST
    • 批量新建行記錄 POST
    • 獲取行記錄詳情 GET
    • 獲取行記錄詳情 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調用頻率限製(QPS)

目前隻對同一IP的調用頻率做限製,不對某個應用或某個用戶做限製。超過限製禁止調用,這可能會影響您的業務,請閤理調用。

接口單個IP的QPS(每秒請求數)
新建行記錄(addRow)20
批量新增行記錄(addRows)20
編輯行記錄(editRow)20
批量編輯行記錄(editRows)20
獲取記錄列錶(getFilterRows)50
其他接口暫不限製
私有部署不限製
  • 通過API獲取記錄列錶最多能獲取1000行

  • API批量新增、更新、刪除最多支持1000行

  • API寫入附件(Base64),最大支持7M


文檔問題反饋

文檔中是否有錯彆字、內容過期、難以理解等問題? 點此給我們反饋吧