平臺API介紹
API(ApplicationProgramming Interface, 應用程式編程接口)是一些預先定義的函數,目的是提供應用程式與開發人員基於某軟件的以訪問一組例程的能力,而又無需訪問源碼,或理解內部工作機製的細節。使用者使用 規定的格式調用 API 即可取得相應資訊。
平臺目前支持的API有以下2個模塊:
一、組織相關的接口
您可以在組織管理 - 集成 - 其他 - 開放接口中查看組織密鑰和接口文檔 。接口文檔主要是組織相關的人員部門、匯報關係、日誌、待辦等數據接口,只有組織管理員可以進列查看管理。
二、應用工作表接口
每個應用創建後,會自動創建對應的API接口,應用管理員可查看接口文檔,也可以將接口文檔分享給開發者。
文檔查看入口:點擊應用名稱右側按鈕,然後點選【API開發文檔】。
具體接口欄表如下:
- 應用
- 取得應用資訊 GET
- 表
- 新建工作表 POST
- 取得工作表結構資訊 POST
- 資料
- 取得欄表 POST
- 新建列資料 POST
- 批次新建列資料 POST
- 取得列資料詳情 GET
- 取得列資料詳情 POST
- 更新列資料詳情 POST
- 批次更新列資料詳情 POST
- 刪除列資料 POST
- 取得關聯資料 POST
- 取得資料分享連結 POST
- 取得工作表總列數 POST
- 應用角色
- 取得應用角色欄表 GET
- 創建應用角色 POST
- 刪除應用角色 POST
- 添加應用角色成員 POST
- 移除應用角色成員 POST
- 退出應用 POST
1. 分享應用API接口
有時非應用的成員也需要查看應用API,例如將本應用和外部應用做對接的實際開發者,此時可以將應用API文檔分享出去。
應用管理員進入【應用管理】菜單 ,然後選擇【API開發文檔】 打開本應用的API接口頁面,在頁面右上角點擊分享按鈕進列分享。
- 在分享的API接口頁面中,所有有關密鑰資訊不會顯示,用到密鑰資訊的示例中會展示為【YOUR_APP_KEY】【YOUR_SIGN】。
- 分享時可以設定連結有效期和密碼訪問。
2. API調用頻率限制(QPS)
目前只對同一IP的調用頻率做限制,不對某個應用或某個使用者做限制。超過限制禁止調用,這可能會影響您的業務,請合理調用。
接口 | 單個IP的QPS(每秒請求數) |
---|---|
新建列資料(addRow) | 20 |
批次新增列資料(addRows) | 20 |
編輯列資料(editRow) | 20 |
批次 編輯列資料(editRows) | 20 |
取得資料欄表(getFilterRows) | 50 |
其他接口 | 暫不限制 |
私有部署 | 不限制 |
- 通過API取得資料欄表最多能取得1000列
- API批次新增、更新、刪除最多支持1000列
- API寫入附件(Base64),最大支持7M