Kompira cloud 共通メニュー利用マニュアル

API ドキュメント

「API ドキュメント」をクリックすると、Kompira cloud で使用できる API の一覧ページに遷移します。

API ドキュメントでは、使用できる API を参照できるほか、実際にリクエストを送ることも可能です。

使用方法

API ドキュメントの使用方法について説明します。

API ドキュメント上部に、以下の通り入力します。

1. sapaceId にご自身の Kompira スペース ID を入力します
2. Authorize をクリックします

ダイアログが表示されるため、以下の通り入力します。

1. 作成した API トークン¹を入力します
   Token XXXXXXXX というように、Token と半角スペースを頭に付けて入力してください
2. Authorize をクリックします

続けて、Close をクリックします。

実行したい API をクリックします。

画面をスクロールし、Parameters 右端の Try it out をクリックします。

Parameters 内が編集可能となるため、必要に応じて以下の通り入力します。

1. 黄色部分のように必要事項を入力します
2. Execute をクリックします

Responses に結果が表示されます。