パブリックAPIの使い方

isaaxのパブリックAPIが利用することで、WEBアプリケーションで行なっている相当の作業をHTTPリクエストを使って行えるようになります。例えば、デバイスの一覧を取得したり、プロジェクトトークンの取得を自動化することができます。より踏み込んだ使い方としては独自のインターフェイスをつくることも可能です。このマニュアルでは簡単な使い方について説明します。

アカウントの準備

パブリックAPIを使うには、isaaxのビジネスプランに登録する必要があります (料金プランはこちら)。また、クーポンコードを使うことで無料で試すことができます。アカウントのアップグレード方法またはクーポンの適用方法は、「よくある質問 - ビジネスプランを利用するにはどうしたら良いですか?」を確認してください。

APIキーの作成

APIキーの作成はWEBアプリケーションのアカウントページから行います。サイドバーまたは右上のユーザーアイコンをクリックして「アカウント」を選択します。

account selection

「APIキー」パネルの「生成」ボタンを押します。次に「キーを表示」ボタンをクリックし、表示された文字列をコピーしてください。これがAPIキーとなります。

api key panel

使わなくなった場合や作り直したい場合は「キーを取り消す」をクリックします。

使い方

curlコマンドを使って実際にAPIを試してみましょう。

エンドポイントはすべて、https://api.isaax.io/がルートとなります。まずはisaaxクラウドの稼働状況を取得してみましょう。

curl --request GET --url 'https://api.isaax.io/status'

レスポンスはすべてJSON形式で返されます。この例ではサービスごとのステータスが返されます。

次にアカウント固有の情報を取得します。この場合は下記のようにAuthorization: BearerヘッダーをHTTPリクエストに含める必要があります。

Authorization: Bearer {API_KEY}

アカウントに紐づいたデバイスの一覧を取得してみましょう。{API_KEY}を前節でコピーしたAPIキーに置き換えてください。

curl --request GET \
  --url 'https://api.isaax.io/devices' \
  --header 'Authorization: Bearer {API_KEY}'

パラメータにクラスターIDなどを含めることによって特定のデバイスを取り出すことも可能です。それぞれのデバイスはインストールされているエージェントのバージョンやインターフェイスに割り振られたIPアドレスなどの情報を結果として返します。

詳しい仕様はパブリックAPIのドキュメントを参照してください。