API: 適用可能なシナリオ
API 連携をいつ使用するか、および CSV との分業。
integrationapi
対象: IT/インテグレーター · 対象: SaaS/プライベート
目標: API が現在の段階に適しているかどうかを確認し、連携ドキュメントを順番に読みます。
適切
- 教務/SIS/中央オフィスの教師、学生、クラスとの定期的な同期
- プログラムでジョブを作成し、運動結果を取得する必要がある
- プライベート展開後のインテグレーターによる統合アクセス
不適切
- 1回限りの小規模ファイル作成(優先CSV)
- 開発リソースがないため、サーバーにキーを保存できません
- スコアのスナップショットを時々エクスポートするだけで済みます (CSV としてエクスポート)
CSV による分業
| 問題 | CSV | API |
|---|---|---|
| 最初のフィールドの検証 | おすすめ | 後で実行できます |
| 毎日の増分同期 | 推奨されません | おすすめ |
| 手動エラー修正 | おすすめ | オプション |
一般的な選択リストについては、どの進行方法を選択するかを参照してください。
読む順序
このヘルプセンターでは業務の流れや確認事項について説明しています。特定のパスとフィールドは、現在の環境の API / OpenAPI ドキュメントに従います。