03-6416-1579

平日 10:00-18:00

SIDfmVM APIの利用方法


SIDfmVM APIとは

SIDfmVM APIは、ご利用中のSIDfmVMのデータを外部のプログラムから簡単に取得することができるAPIです。
ここでは、SIDfmVM APIの利用方法についてご説明します。

APIキーの登録方法について

SIDfmVM APIを利用するには、APIキーが必要です。
APIキーの登録方法は SIDfmVM APIキー設定 APIキーを作成する 及び APIキーを登録/更新する をご参照ください。

エンドポイントについて

SIDfmVM APIには、現在参照系のAPIのみされており、エンドポイントに対してGETもしくはPOSTのHTTPメソッドでパラメータを送ることでデータを取得することができます。
利用可能なエンドポイントについては、エンドポイント一覧をご参照ください。

リクエスト

すべてのリクエストには必ず、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" }
}

サンプルコード

一例として、SIDfmVM APIでカテゴリ一覧を取得するサンプルコードを示します。
※ 実際にサンプルコードを試す場合は、色のついている箇所をご自身の環境に合わせて変更しご利用ください。
サンプルコードを試す場合、変更箇所の「http(s)://hostname/redmine」は、システム設定の「メール通知設定用のURL」を、「apikey」は、VM APIキー設定画面で登録済みのAPIキーを設定する必要があります。