跳至主要内容

如何通過API嚮工作錶讀寫數據

平臺為具有開發能力的用戶提供瞭API接口，可以將工作錶和自有係統進行數據對接，將外部數據寫入到工作錶中或讀取工作錶中的數據。

應用舉例​

您在訂單管理應用中創建一個訂單錶，用於統一管理綫上和綫下的訂單。您還有一套綫上銷售係統用於記錄在綫訂單每當客戶在綫下單時，就可以通過工作錶API接口，直接嚮《訂單》錶中 寫入一條新的訂單數據，即省力，又避免人工錄入的齣錯。

API接口說明​

應用管理員打開[API開發文檔]，可查看本應用下所有的API接口。

      

企業授權說明​

本平臺使用基於令牌的身份驗證，AppKey 與 SecretKey在應用的開發文檔中會提供，超級管理員也可以重新生成。

字段與控件類型對照錶​

         

字段ID： 係統為字段自動生成的ID，不能更改，通過API寫入數據時需用字段ID代錶本字段。

字段名稱： 管理員為字段定義的名稱。

類型： 字段所選擇的控件類型

控件類型編號： 所用控件的類型編號，一般在API傳參時使用，不同的類型，篩選方式也會有所不同。

說明： 當前字段使用說明，如數據類似及樣例數據,是否支持寫入等信息。

工作錶彆名和字段彆名： 由於錶ID和字段ID是一串長字符，不方便記憶和書寫，可以為工作錶和字段設置彆名，在API傳參時使用彆名和用ID具有相同效果。

新增記錄接口​

應用提供瞭10多個接口，滿足數據的所有操作場景，我們以新建一行記錄為例進行說明，即通過API嚮工作錶新增一行記錄。

      

規則​

  • API請求地址為：https://api.nocoly.com/v2/open/worksheet/addRow

  • 參數appkey、sign、worksheetid、controls及controlId可以直接復用右側已經提供的值。 參數名不需要更改，是根據當前錶自動生成的，在測試時隻需要修改參數值。

請求示例,可直接復製使用

{
  "appKey": "15d5b427b4bbf1b6",
  "sign": "ZDRjZDEzM2Q3YzUzMGI1ZDhjOWNhOWQ2MzFiZDkxNDY1NmYyZjBiYjE1YzYzZGMxNGU0MmNjZDA2NjJmYjViNA==",
  "worksheetId": "655c79654120176fa4758593",
  "controls": [
    {
      "controlId": "6426808e315e39d1e4dae83e",
      "value": "This is a test"
    },
    {
      "controlId": "5e0a02642134520001e19345",
      "value": "666.66"
    }
  ],
  "triggerWorkflow": true
}

響應參數及返迴數據示例

{
    "data": "75f221fb-d645-4010-92cb-acced0c73cea",
    "success": true
}

錯誤對照錶

ErrorCode說明
0失敗
1成功
10001缺少參數
10002參數值錯誤
10005數據操作無權限
10007數據不存在
10101請求令牌不存在
10102簽名不閤法
99999數據操作異常

模擬測試

在這裏，我們通過一個簡單的在綫API接口測試，模擬下外部數據的寫入。

API在綫測試工具：https://hoppscotch.io  ，您也可以使用其他API測試工具。

      

  1. 將API請求地址粘貼到輸入框
  2. 選擇 Post"方式
  3. 選擇 "Body" 提交方式
  4. Content Type 選擇 "application/json"
  5. 將前麵的請求示例代碼粘貼到編輯框中
  6. 點擊send按鈕提交
  7. 下方顯示提交結果，如果顯示 "success": true ，說明已正確寫入，可以刷新下工作錶查看新數據，創建人為API。

相關參數獲取方法​

在測試時，我們可以先獲取一個固定的參數值進行調試，例如視圖ID和行記錄ID(rowId)。

行記錄ID（rowId）​

要獲取rowid需打開記錄的詳情頁麵。進入工作錶>找到目標記錄>選擇"新頁麵打開",在打開頁麵的鏈接中row/之後的一串內容就是記錄ID。如下圖中獲取到記錄ID（rowId）就是：d0bd3216-5274-4f59-a153-de80ec203838

視圖ID​

在獲取記錄列錶的時，需要用到視圖ID，在接口說明中會顯示所有視圖名稱及視圖ID。

      

文檔問題反饋

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

這篇文件對你有幫助嗎？