CloudGarage

03-6630-8545 平日10:00〜18:00 (当社指定日は除く) 平日10:00〜18:00

CloudGarageサービスサイト

最終更新日 2018.12.06ID #1159

Public API のご利用方法

CloudGarage のPublic API のご利用方法についてご説明します。
提供しているAPI の一覧はCloudGarage API リファレンスを参照ください。
ご利用までの大まかな流れは以下の通りです。

  1. CloudGarage コントロールパネルからAPI Key の発行を行う
  2. 発行したAPI Key を利用し、Token の発行を行う
  3. Token をHttp Header に設定し、Public API をCall する

1. API Key を発行する

CloudGarage コントロールパネル右上メニューから「アカウント情報確認 / 変更」を選択し、アカウント情報確認画面へと遷移します。

アカウント情報確認画面下部に「API Key 管理」という項目がありますので、右側に配置している「API Key 発行」ボタンを押下します。

API Key を発行する旨を問い合わせるモーダルダイアログが表示されます。
「OK」 を押下することでPublic API の利用に必要なToken を発行するためのAPI Key が発行されます。



発行したAPI Key(Client ID, Client Secret) は右側のボタンからコピーしてご利用ください。
発行したAPI Key は再発行を行うことで失効します。
API Key が外部流出した場合は再発行を行ってください。

2. Token の発行を行う

手順1. で発行したAPI Key を利用してToken の発行を行います。
レスポンスBody 部のtoken オブジェクトに含まれるid の値がPublic API をCall する際のToken 情報です。
本ページではcurl を利用してご案内いたしますが、Postman やRestlet Client といったHTTP リクエストを手軽に送信できるツールをご利用いただくと便利です。

3. Public API を実行する

手順2. で発行したToken 情報をHTTP リクエストのX-Auth-Token Header にセットし、
Public API の呼び出しを行います。

※ 本ページで利用したAPI Key 情報およびにToken 情報はサンプル値であり、利用することはできません。

キーワード検索