參數説明 - Jodoo - 開放平臺

參數説明

簡介

在參數說明文件中，透過切換應用及表單可以快速查詢 API 偵錯所需要的參數。同時為開發人員提供一體式的文件、偵錯、程式碼範例生成功能，以支撐高效的開發與查閱。

適用於有一定開發能力的企業，能夠透過 API 自訂開發內容，進行 Jodoo 平台對接等。

以在參數說明界面，查看產品管理系統中的表單及欄位資訊為例，效果如下所示：

進入「開放平台 > 開發文件」中，點擊「參數說明」即可進入到參數說明詳情頁中。

進入參數說明詳情頁後，在左上角「應用切換」處，可透過下拉單選選擇不同的應用。

1. 選擇好應用之後，在左側表單列表中選擇好表單之後，即可查看到表單的相關資訊。如表單所屬的應用 ID、表單 ID、欄位名稱、欄位 ID、欄位類型等。

2. 若表單內的欄位過多，還可透過右上角的搜尋框，搜尋出欄位名稱後進行欄位資訊的查看。如下所示：

在 API 偵錯平台中，選擇需要偵錯的 API，並輸入相應的 API 密鑰及請求參數即可進行偵錯。詳情可參見文件：API 偵錯台。

點擊「設定欄位別名」，可以對錶單內的欄位設定欄位別名。

附註：
欄位別名僅允許使用「小寫字母」「數字」和「下劃線」組合，且必須以「小寫字母」開頭。

點擊「欄位 JSON 樣例」，可以查看錶單內欄位的 JSON 程式碼。企業可根據自身需求，複製 JSON 程式碼進行API 偵錯。