APIの利用方法

APIを利用してSIM情報・ログ情報等の収集を行えます。ここではAPIの作成方法・利用方法について説明します。


API ID と Secretの作成方法

  1. rootユーザでログインし、 Setting > Generate の順でクリックします
    ../_images/1685538091.png
  2. Generate ボタンを押し、確認ダイアログでさらに Generate をクリックします
    ../_images/1685538280.png
  3. API-IDSecret が表示されますので、控えておきます
    • 同時に利用可能な API-ID は一つです
    ../_images/1685538280.png

APIの利用方法

  1. ユーザー名をクリックして表示される OpenAPI Docs を開きます
    ../_images/1685590940.png
  2. Authorize をクリックし、 api_idapi_secret を入力し、それぞれの Authorize をクリックし、 X でウィンドウを閉じます
    ../_images/1685591191.png
  3. 所望のAPIを選択し、さらに Try it out をクリックします
    ../_images/1685618923.png
  4. Execute をクリックし、結果を確認します
    • curl で表示されるリクエストが実際のリクエスト内容です
    • Server response 直後のメッセージが実際の返却値になります
    ../_images/1685617464.png

注釈

  • ブラウザを再読み込みなどすると、ブラウザ内に設定されたAPI-IDとKeyは削除されます。
  • 本ページはAPIの利用方法を具体的に把握するためのマニュアルとしてご利用ください。