外部インターフェース（API）¶
設備台帳システムのデータを、外部システムからAPI経由で取得するための仕様です。台帳確認画面のExcel出力機能と同じ内容を、JSON形式で参照できます。既設システムとの設備ID相互変換用のAPI（6・7）も含みます。
この機能について
すべて参照専用（GET）のAPIです。台帳データの登録・修正・削除はできません（従来どおりWebアプリの画面から行ってください）。
共通仕様¶
| 項目 | 内容 |
|---|---|
| ベースURL | https://dragonite.i-comons.com/functions/v1/ |
| HTTPメソッド | すべてGET |
| 認証 | リクエストヘッダーX-API-Key: <発行したAPIキー>が必須 |
| レスポンス形式 | JSON |
| CORS | 全許可（Access-Control-Allow-Origin: *） |
| フィールド名 | DB上の列名に準拠したsnake_case（英語） |
成功時（200）は次の共通エンベロープを返します。
{ "generated_at": "2026-07-17T09:00:00.000Z", "count": 5, "items": [ { "...": "..." } ] }
エラー時は{ "error": "エラーメッセージ" }を返し、状況に応じたステータスコードを付します。
| コード | 意味 |
|---|---|
| 400 | パラメータ不正 |
| 401 | APIキー未指定・不正 |
| 404 | 対象データなし |
| 405 | メソッド不正 |
| 500 | サーバー内部エラー |
API一覧¶
| # | 名称 | エンドポイント | 主なパラメータ |
|---|---|---|---|
| 1 | 設備一覧出力API | GET /export-equipments |
search / system_category_kbn / equipment_type_id（すべて任意） |
| 2 | 個体設置明細出力API | GET /export-individual-installations |
同上 |
| 3 | 個体属性値一覧出力API（縦持ち） | GET /export-individual-attributes |
同上 |
| 4 | 設備個体属性値出力API（横持ち） | GET /export-equipment-individual-attributes |
equipment_id（必須） |
| 5 | 撤去済み個体一覧出力API | GET /export-removed-individuals |
search / system_category_kbn / equipment_type_id（すべて任意） |
| 6 | 設備ID変換API（外部ID→統合設備ID） | GET /resolve-equipment-id |
external_system_code / external_equipment_id（いずれも必須） |
| 7 | 設備ID変換API（統合設備ID→外部ID一覧） | GET /get-external-equipment-ids |
equipment_id（必須） |
呼び出し例（API1〜5）¶
curl "https://dragonite.i-comons.com/functions/v1/export-equipments?system_category_kbn=5" \
-H "X-API-Key: <発行したAPIキー>"
呼び出し例（API6: 外部ID→統合設備ID）¶
curl "https://dragonite.i-comons.com/functions/v1/resolve-equipment-id?external_system_code=ICORUS&external_equipment_id=FC-000123" \
-H "X-API-Key: <発行したAPIキー>"
呼び出し例（API7: 統合設備ID→外部ID一覧）¶
curl "https://dragonite.i-comons.com/functions/v1/get-external-equipment-ids?equipment_id=1" \
-H "X-API-Key: <発行したAPIキー>"
設備ID変換API（6・7）について¶
設備台帳システムの設備ID（equipment_id。以下「統合設備ID」）は本システム内でのみユニークですが、本システムは複数の既設システムからAPI・MCP経由で参照されます。既設システムは独自の設備IDを持っているため、相互変換用の変換マスタ（既設システム／設備ID変換マスタ）とAPIを用意しています。
- 既設システムが指す対象の粒度: 既設システムが構成要素（子）や場所を指している場合も、変換マスタでは常にその親の「設備」1件にマッピングする運用ルールです。したがって6・7のAPIが返す
equipment_idは必ず設備単位であり、構成要素単位の対応情報は持ちません。 - カーディナリティ: 1つの外部設備IDは1つの統合設備IDのみに対応します（既設システムごとに一意）。逆に、1つの統合設備IDに複数の既設システム・複数の外部IDが対応することは許容されます（API7はこの一覧を返します）。
- 変換マスタ自体の登録・編集は、Webアプリの「設備IDメンテナンス」配下（既設システム／設備ID変換マスタ）から行います。
運用メモ¶
- APIキーは配布元（お問い合わせ先）が発行・管理しています。キーのローテーション・複数キー発行・レート制限は現時点では未対応です。
- Claude Desktopから日本語で問い合わせたい場合は、Claude Desktop連携（MCPサーバー）を参照してください。このAPIをそのまま利用しています。
お問い合わせ先¶
原田正昭（harada-ms@itec.hankyu-hanshin.co.jp）