SIDfmVM APIの利用方法

リクエスト

すべてのリクエストには必ず、VM APIキー設定画面で登録済みのAPIキーをX-API-Keyとしてリクエストヘッダに含めるか、パラメータにapi_keyとして指定する必要があります。
また、エンドポイントのリクエストボディは、content-type: application/x-www-form-urlencoded である必要があります。

レスポンス

レスポンスはJSON形式となります。
下記はカテゴリ一覧を取得するGET /categoriesの実行例です。

{
  "success": true,
  "response": {},
  "total_size": 1,
  "categories": [
    {
      "id": 23,
      "name": "業務 部",
      "desc": "業務部",
      "hostlim": 7,
      "is_system": false
    }
  ]
}

リクエストエラーの場合は、{ "success": false, "response": { "message": エラーメッセージ } }を返します。
下記はAPIキーが間違っていた場合のエラー例です。

{
  "success": false,
  "response": { "message": "invalid apikey" }
}