API 偵錯台
簡介
功能簡介
API 偵錯台是指,開發者在偵錯台中選擇需要偵錯的 API,並輸入相應的 API 密鑰及請求參數即可進行偵錯。能夠降低開發者的開發成本,讓開發者可以快速上手、完成開發。
使用場景
適用於開發人員在開發過程中,根據 API 資訊發送請求、查看回應和調整參數。如:
- 使用偵錯台測試 API 的不同端點和功能,確保 API 按照預期工作,參數被正確傳遞,且回應符合預期;
- 開發者可以輕鬆調整請求參數,以查看不同輸入對 API 的影響,以便找到最佳配置;
- 查看詳細的錯誤資訊,有助於快速定位和解決問題。
預期效果
以「取得成員資訊」API偵錯為例,效果如下所示:
操作步驟
操作入口
1. 參數說明處入口
透過「參數說明 > API 偵錯台」處,可以進入 API 偵錯平台直接進行 API 偵錯:
2. API 文件內入口
除了參數說明文件中可以進入到 API 偵錯平台,說明文件對應的 API 文件也可以直接進入到 API 偵錯平台,如下圖所示:
選擇 API
在左側「API 列表」中,選擇需要進行偵錯的 API 。如選擇「取得成員資訊」API,如下所示:
設定請求頭
選擇 API 後,設定如下所示內容:
- Authorization:設定為 Jodoo的 API Key,可在「開放平台 > 密鑰管理」處建立並複製 API Key。
- 服務地址:API 調用的服務地址。
設定請求體
在請求體中修改必填參數,以便對 API 進行偵錯。如在「取得成員資訊」API 當中,需將參數 username 替換為Jodoo企業內要查詢的成員編號,如下所示:
查看偵錯結果
請求頭和請求體都設定完成後,點擊「開始偵錯」,即可查看偵錯結果。如下所示: