Vercel管理APIガイド (v1.2)
GIIPプラットフォームは、Vercelプロジェクトの設定を管理し、デプロイ履歴を照会するためのAPIを提供します。このAPIは、基本的にSk3(JSONデータベース)インターフェースを使用してリクエストを処理します。
📋 概要
Vercel管理APIは、GIIPに登録されたVercelプロジェクト設定の照会や、最新のデプロイ履歴のモニタリングに使用されます。
🔐 認証とセキュリティ
すべてのリクエストには、GIIP共通認証ヘッダーを含める必要があります。
- Header:
x-giip-ak,x-giip-sk - Body Context: Sk3インターフェース (jsondataフィールドを使用)
📡 API詳細 (Sk3)
1. Vercel設定リストの照会 (VercelConfigsList)
- コマンド:
text=VercelConfigsList - jsondata:
{"csn": 123}(オプション: プロジェクト識別子) - 説明: 現在登録されているすべてのVercel設定情報と連動したVercelプロジェクト名を返します。
2. Vercel設定の生成 (VercelConfigCreate)
- コマンド:
text=VercelConfigCreate - jsondata:
{
"csn": 123,
"configName": "Production_Main",
"vercelProjectName": "giip-next-app",
"vercelToken": "vcl_token_...",
"vercelTeamId": "team_xxx",
"vercelProjectId": "prj_xxx"
}
3. Vercel設定の修正・削除 (VercelConfigUpdate / VercelConfigDelete)
- 修正:
text=VercelConfigUpdate+{"vcId": 123, ...} - 削除:
text=VercelConfigDelete+{"vcSn": 123}(またはvcId)
4. デプロイ履歴の照会 (VercelDeploymentsList)
- コマンド:
text=VercelDeploymentsList - jsondata:
{"vcId": 123, "limit": 20} - 説明: 特定の設定(vcId)に該当するVercelデプロイリストを最新順に照会します。
🛡️ Sk3(高性能ロギング)の活用
Vercel管理APIは、設計段階から giipApiSk3 インターフェースを標準として採用しています。すべての設定管理および照会リクエストに対して詳細な実行コンテキストとエラー追跡を提供します。
- エンドポイント:
https://giipfaw.azurewebsites.net/api/giipApiSk3 - 利点: Vercelトークンのエラーやデプロイステータスの同期失敗時、呼び出し元のIP、User-Agent、および詳細なサーバー側スタックトレースを自動的に記録し、連携に関する問題を迅速に診断できるように支援します。
- 活用チップ:
VercelConfigCreateのようにパラメータが多いリクエストを送信する際、jsondataオブジェクト構造を活用することで、複雑なトークン値を失うことなく安全に送信し、ログを残すことができます。
🔧 トラブルシューティング
| 症状 | 原因 | 解決 |
|---|---|---|
| リクエストが認証エラーで拒否される | x-giip-ak / x-giip-sk ヘッダーの欠落または不正なキー | 有効な認証ヘッダーを含めて再リクエスト |
text コマンドが認識されない、または空のレスポンス | text 値のスペルミス(例: VercelConfigList ↔ VercelConfigsList) | 正確なコマンド名を確認し text パラメータに指定 |
| デプロイリストが空、または同期に失敗 | vercelToken が期限切れまたは不正 | VercelConfigUpdate で有効なトークンを更新後、再照会 |
VercelDeploymentsList が結果を返さない | vcId が正しくない、または該当設定にデプロイ履歴がない | VercelConfigsList で正しい vcId を確認して再リクエスト |
バージョン: 1.3
最終更新日: 2026-04-11
ソースファイル: giipv3/public/help/api-vercel.ja.md
関連ドキュメント: