MatrixFlowマニュアル

サービスの詳細と実行コードの作成（プロジェクト管理）

作成したサービスの内容を確認し、APIを実行するコードを作成します。

■プロジェクト管理サービスのサービスIDとシークレットキーの確認

サービス管理画面［プロジェクト管理サービス］タブのサービス一覧から、詳細を確認したいサービスを選んで詳細画面に進みます。

＜プロジェクト管理サービスの詳細画面＞

1. サービスID
   APIごとに付与される一意のIDです。
   APIを介してMatrixFlowに接続するためのURLに指定する値です。
   右端のクリップアイコンをクリックすると、クリップボードにコピーします。
   ※API URLは「プロジェクト管理サービス API仕様」を利用して生成し、外部システムに設定します。
2. シークレットキー
   APIごとに付与される一意の暗号キーです。
   APIを介してMatrixFlowに接続するための認証情報で、外部システムに設定します。
   右端のクリップアイコンをクリックすると、クリップボードにコピーします。
3. API仕様書
   プロジェクト管理は機能が多岐に渡るため、API仕様を一覧にまとめています。
   詳細は後述をご覧ください。

■実行コードの作成

MatrixFlowでは、プロジェクト管理サービスのみAPI仕様書に Swagger を利用しています。
Swagger はAPI機能の一覧としてだけではなく、実行コードを生成したり（curlのみ）、生成したコードを試しに実行し、レスポンスを得ることができるツールです。
Swagger上で実行が成功したコードをコピー＆ペーストして、外部システムに組み込むことができます。

＜API仕様書の見方＞

1．プロジェクト管理サービス API仕様 を開きます。
プロジェクト管理サービスで実行できる機能が管理メニューごとに一覧になっています。

2．機能一覧から実行したい機能をクリックして詳細を開きます。
その機能を実行するためのパラメータの一覧（Parameters）と、実行したときのサーバーレスポンスの一覧（Responses）が必ず表示されています。また、機能によって（POSTとPATCH）は Request Body も表示されます。
パラメータ一覧、サーバーレスポンスのステータスコード、返り値の形式はここで確認します。

＜Swagger を使った実行コードの生成＞

1．詳細を開いた画面「Parameters」右端の［Try it out」をクリックすると、「Parameters」の各項目が編集できるようになります。

2．MatrixFlowのサービス管理で作成したプロジェクト管理サービスの詳細を参照して「サービスID」と「シークレットキー」、その他必要なパラメータを入力します。

例）「データセット管理」で「データセット一覧を取得」する

このとき、サービス管理で発行されないサービスIDとシークレットキー以外のパラメータを要求されるケースがありますが、そのようなパラメータは別の機能を実行すると得ることができます。
例えば、「サービス管理」の「プロジェクト管理サービスの情報を取得」のパラメータ「project_service_id」は、「サービス管理」の「プロジェクト管理サービスの一覧を取得」すると得られます。

3．必須パラメータを入力したら、「Execute」をクリックし実行してみます。

4．実行が終わると Responses の先頭に、実行したcurlのコード、Request URL、サーバーからのレスポンス（Server response）が表示されます。
Server response の Code が 200 であれば成功です。Detailsには実際のレスポンスが表示されます。

最後に外部システムに組み込みます。
curlであれば、生成されたコードをコピー＆ペーストで、
他の言語であれば、生成されたコードを参照して作成します。