コラボフロー REST API “Try it out”の使い方

はじめに

今回は、「コラボフロー REST API」の”Try it out”の使い方について書いていこうと思います。

コラボフロー REST APIとは

コラボフロー REST APIを利用する事で外部システムと連携し、申請書の取得/申請/判定や、組織情報の取得/登録/更新などの操作が行えます。
各REST APIの使用方法など詳細はコラボフロー REST APIリファレンスをご確認ください。

Try it outとは

Try it outは実際の認証文字列を使って、実際のクラウド環境に対してリクエストをかける機能です。リクエストはコラボフローAPIサイトから行われるため、お客様環境のプロキシの影響などを受けません。

Try it outの使い方

1. コラボフロー REST APIサイトにアクセスし、(1)対象のサーバーを選択し(2)インスタンス名を入力します。
   
2. 右側にある「Authorize」をクリックし、画面の説明に従ってコラボフローのヘッダーに指定する文字列を入力し「Authorize」をクリックします。
   
3. 動作を確認したいAPIを探し、右側にある「Try it out」をクリックします。
   
4. 動作を確認したいAPIを探し、(1)任意のパラメータを指定して、下部の(2)「Execute」をクリックすると、APIが実行されます。
   
5. APIが実行されると実際に利用された(1)Curlのコマンドと、Request URL及び、リクエストの結果が表示されます。
   

注意

• Try it outで実行されたAPIの結果は実際に対象のクラウド環境に反映されます。削除操作など運用に影響のある操作を行う際は、十分に注意して実行してください。
• リクエストはコラボフローAPIサイトから行われるため、「Try it out」で正常に動作するCurlコマンドを、お客様PCで実行しても、正確に動作しない可能性があります。

さいごに

Try it outの使い方については以上となります。是非、Try it outを使ってコラボフロー REST APIの動作を確認してみて下さい。