API確認テンプレート
API提供者へ確認するときは、空欄のままにせず、未確定事項には「決定者」と「確定期限」を記載します。
1. 基本情報
Section titled “1. 基本情報”| 項目 | 記入内容 |
|---|---|
| API名 | |
| 提供者・開発会社 | |
| 契約者・費用負担者 | |
| 利用目的 | |
| 利用する画面・機能 | |
| 仕様書URL・版 | |
| 問い合わせ窓口 | |
| 本番開始予定日 |
2. データ・機能
Section titled “2. データ・機能”| 項目 | 記入内容 |
|---|---|
| 取得・作成・更新・削除 | |
| エンドポイント | |
| 必要な入力項目 | |
| 必要なレスポンス項目 | |
| 必須・任意・文字数 | |
| 検索条件・並び順 | |
| 最大取得件数 | |
| ページング | |
| データ更新頻度 | |
| データの正本 | |
| 多言語・タイムゾーン |
3. 認証・セキュリティ
Section titled “3. 認証・セキュリティ”| 項目 | 記入内容 |
|---|---|
| 認証方式 | APIキー、OAuth、署名等 |
| 必要権限 | |
| ブラウザから直接利用可能か | |
| CORS設定 | |
| IP・ドメイン制限 | |
| APIキーの保管場所 | |
| キーの発行・更新・失効担当 | |
| 本番・検証キーの分離 | |
| 個人情報・機密情報 | |
| ログへ残してよい情報 |
4. 性能・利用制限
Section titled “4. 性能・利用制限”| 項目 | 記入内容 |
|---|---|
| 想定アクセス・呼び出し数 | |
| レート制限 | |
| 月間クォータ | |
| 一回の最大件数・容量 | |
| 通常・最大応答時間 | |
| タイムアウト | |
| キャッシュ可否・保持時間 | |
| 超過時の挙動・料金 | |
| 利用量アラート |
5. エラー・障害
Section titled “5. エラー・障害”| 項目 | 記入内容 |
|---|---|
| エラーコード・形式 | |
| 0件・対象なしの扱い | |
| タイムアウト時の表示 | |
| 再試行可能な処理 | |
| 二重登録防止 | |
| 部分成功の扱い | |
| API障害時の代替表示 | |
| 監視・通知担当 | |
| ステータスページ | |
| SLA・サポート時間 | |
| 復旧後の再処理 |
6. 開発・テスト
Section titled “6. 開発・テスト”| 項目 | 記入内容 |
|---|---|
| 開発・検証・本番環境 | |
| サンドボックス・モック | |
| テストアカウント | |
| サンプルデータ | |
| 本番との差異 | |
| API仕様確定日 | |
| 接続試験日 | |
| 負荷・異常系試験 | |
| 本番データ利用可否 |
7. 変更・終了
Section titled “7. 変更・終了”| 項目 | 記入内容 |
|---|---|
| APIバージョン | |
| 変更通知先 | |
| 廃止予告期間 | |
| メンテナンス通知 | |
| 料金改定通知 | |
| 仕様変更時の改修担当 | |
| 保守契約に含む範囲 | |
| API終了時の代替案 |
8. 責任分界
Section titled “8. 責任分界”| 作業・事象 | API提供者 | クライアント | 制作・保守会社 |
|---|---|---|---|
| 仕様確定 | |||
| 認証情報発行 | |||
| フロント実装 | |||
| API側改修 | |||
| 監視・一次切り分け | |||
| 障害連絡 | |||
| 仕様変更対応 | |||
| 利用料・超過費 | |||
| 個人情報管理 |