API 管理

定義

このモジュールは、プラットフォーム内外の API サービスを一元管理するために使用します。グラフィカルウィザードまたは SQL 作成によりデータサービス API をすばやく作成でき、サービス転送や地理空間サービス対応などの機能を提供し、多様なデータ公開・共有ニーズに対応します。

API 作成モード

• ウィザード設定: グラフィカルなプロセスで、データソース選択、フィールド設定、出力形式、権限設定などを案内します。コードを書かずに API をすばやく作成できます。
• SQL モード: SQL クエリ文を直接作成してデータサービスを構築できます。複雑な業務ロジックや柔軟なデータ抽出に適しています。
• 補助属性: API アップデート周期、アップデート時刻、サービス説明、アクセス権限などの補助情報を設定でき、サービス管理と監視に使用します。

---

サードパーティサービス転送とアクセス

• 汎用サービス転送: 下流の地域・流域組織が開発したサードパーティ API へのアクセスと転送に対応します。

注意

API を公開する前に、データソース権限と機密フィールドの処理を確認してください。サードパーティ転送サービスでは、API の乱用や漏えいを避けるため、レート制限と認証ポリシーを設定することを推奨します。

適用範囲

プラットフォーム内データの外部サービス化、サードパーティシステムサービスの統一アクセスと転送、地理・動画サービスの統合管理などのシナリオに適用されます。政府、業界、企業データのサービス化出力と統一呼び出しを実現します。

1. API 管理ページ

データサービス 配下の API 管理 をクリックすると、API 管理ページが開きます。ページは左右に分かれており、左側に API サービスカテゴリをツリー構造で表示し、右側に API 名、API カテゴリ、API バージョン、API パスなどの項目を含む一覧を表示します。

API 管理ページ.png

2. API サービスの登録

登録 をクリックし、ダイアログで API サービス情報を入力して OK をクリックすると、API サービス情報の登録が完了します。

API サービス登録ページ.png

2.1. 属性設定

API サービス登録ページを開きます。属性設定 モジュールで API 名、API バージョンなどの情報を入力し、次へ をクリックして パラメータ設定ページ を開きます。

属性設定ページ.png

2.2. パラメータ設定

パラメータ設定ページを開き、設定方式を選択してパラメータ情報を入力します。データソース設定には、単一テーブルウィザード、SQL スクリプト、サードパーティ転送の 3 方式があります。その後 次へ をクリックして テスト ページを開きます。

パラメータ設定ページ.png

2.3. テスト

テストページを開き、パラメータ値を入力して API 呼び出し をクリックします。システムがテスト結果を返します。完了後、保存して終了 をクリックします。

テストページ.png

API 呼び出しテスト結果.png

3. API サービスの編集

編集する API サービスを選択し、操作列の 編集 をクリックします。表示されたページで既存の API サービス情報を編集し、編集後に 保存して終了 をクリックすると、API サービス情報の編集が完了します。

属性設定編集ページ.png

パラメータ設定編集ページ.png

テスト編集ページ.png

4. API サービスの取り除き

取り除く API サービスを選択し、操作列の 取り除き をクリックして、ダイアログで OK をクリックすると、API サービスの取り除きが完了します。

API サービス取り除きページ.png

5. API サービス詳細

詳細を表示する API サービスを選択し、操作列の 詳細 をクリックして、表示されたページで API サービス詳細を確認します。

API サービス詳細ページ.png

API サービス詳細ページ.png

6. 有効化/無効化

有効化または無効化する API サービスを選択し、ステータス列の スイッチ をクリックすると、有効化/無効化が完了します。

有効化/無効化操作ページ.png

7. サービス API 認証

7.1 背景

システムは データサービス で統一 API アクセス機能を提供します。呼び出し側はまず アプリケーション認証 API を通じて アクセストークン を取得し、そのトークンを付与して業務 API にアクセスする必要があります。

---

7.2 アプリケーションキーの取得

1. 管理者が 基本管理 鈫?アプリケーション管理 で、指定担当者向けにアプリケーションを作成または割り当てます。
2. 各アプリケーションは一意の認証情報セットを生成します。
   • client_id: アプリケーション識別子
   • client_secret: アプリケーションキー
3. アプリケーションキー (client_secret) は通常、管理者画面で表示されます。管理者がコピーして該当ユーザーに割り当てます。

注意: client_secret は機密情報です。ユーザーは適切に保管してください。漏えいした場合は、ただちに管理者へ連絡してリセットしてください。

---

7.3 トークン取得

API 情報

• API パス: POST http://127.0.0.1:8080/prod-api/oauth2/client_token
• 説明: client_id と client_secret でアクセストークンを取得します。

リクエストパラメータ

パラメータ名	型	必須	説明
grant_type	string	はい	固定値 client_credentials。クライアントモードを示します
client_id	string	はい	アプリケーション ID
client_secret	string	はい	アプリケーションキー
scope	string	いいえ	任意パラメータ。API アクセス範囲の制御に使用します

レスポンスパラメータ

フィールド名	型	説明
code	integer	ステータスコード。200 は成功、500 は失敗を示します
msg	string	返却メッセージ説明
data	null	予約フィールド
token_type	string	トークン種別。通常は bearer
client_token	string	API 呼び出し時に使用するアクセストークン
expires_in	integer	トークン有効期間。単位は秒
client_id	string	返却されるアプリケーション ID
scope	string	トークンの範囲

---

7.4 トークンで業務 API を呼び出す

client_token の取得に成功した後、業務 API を呼び出す際は リクエストパラメータ に含める必要があります。

• URL 例

 http://127.0.0.1:8080/prod-api/services/v1.0.1/getDaDiscoveryTaskDO