受眾:IT / 整合商 · 適用:SaaS / 私有
目標:確認 API 是否適合當前階段,並按順序閱讀整合文檔。
適合
- 與教務 / SIS / 中臺 定期同步 師生與班級
- 需要程式化創建作業、拉取練習結果
- 私有部署後由整合商統一接入
不適合
- 一次性小規模建檔(優先 CSV)
- 無開發資源、無法在服務端保管密鑰
- 僅需偶爾導出成績快照(用 CSV 導出即可)
與 CSV 的分工
| 事項 | CSV | API |
|---|
| 首次欄位驗證 | 推薦 | 可後做 |
| 日常增量同步 | 不推薦 | 推薦 |
| 人工糾錯補錄 | 推薦 | 可選 |
選型總表見 選哪種進數方式。
閱讀順序
- 整合前準備
- 認證與調用約定
- 典型同步流程
- 聯調與上線清單
本說明中心描述業務順序與檢查項;具體路徑與欄位以當前環境的 API / OpenAPI 文檔為準。