ServiceHUB

説明資料

ServiceHUBとは

Service Hub（仮称）とは、API提供プラットフォームです。

API提供者は、所有するAPIを登録して利用者に対して公開することができます。

API利用者は、公開されたAPIを利用することができます。

見やすいAPI定義

​

Service Hub（仮称）から提供される各APIは、API定義が確認しやすいようになっています。

API提供者からAPI定義ファイル（OpenAPI）を受領してページに展開されるため、リクエスト・レスポンスの仕様が詳細に確認できます。

API提供者

API提供者

​

API提供者は、APIの登録を行うことでAPIを利用者に向けて開放することができます。

公開されたAPIは、利用者が利用申請を行い、承認することで初めて利用開始できます。

API登録

​

API提供者は、API登録画面からAPIを登録することができます。

API定義書（OpenAPI）をアップロードすることでAPI定義ページが動的に作成されます。

登録されたAPIはService Hub（仮称）のプロキシを通じて利用者からのリクエストを受け付けます。

API利用申請管理

​

API提供者は、API提供開始後にAPI利用希望者からの申請に対するアクションを行うことができます。

承認されたユーザーのみAPIを利用することができます。

API利用者

API利用者

​

API利用者は、様々なAPIの中から利用したいAPIを選んで利用申請することができます。

また、各API毎にメタデータやインベントリの管理を行うことができます。

API利用者

​

API利用者は、API一覧から利用したいAPIを選んで利用申請することができます。

APIの利用申請後は、API提供者による審査後に承認された場合に利用できるようになります。

サービス・プロジェクト

​

サービス・プロジェクトの説明

メタデータの登録

​

API利用者は、APIエンドポイントごとにメタデータを複数登録できます。

メタデータはKeyとValueをそれぞれ定義して設定可能です。

インベントリ紐付け

​

API利用者は、予め定義されたインベントリ一覧からAPIエンドポイント毎に複数紐付けることができます。

インベントリは土木工事共通仕様書の項目から選択できます。