APIリファレンス

！！2026年6月2日をもって、本機能は停止となりました！！

　※後継のAPIは、2026年7月中旬にリリース予定※

目次

1. 目的

2. API機能

3. インシデント登録

4. インシデントステータス更新

5. インシデント詳細

6. インシデント一覧

7. 受信アドレス一覧

1. 目的

本ドキュメントは、株式会社ビリーフワークスが提供するアラートメールフィルタ( 以降AMFと呼称 )に対してAPIを利用して各種機能を利用する事ができます。

そのAPI機能のリファレンスマニュアルが本書となります。

2. API機能

2-1. 概要

APIの利用に伴う概要は以下となります。

2-2. API-Keyの取得

APIを利用するにはユーザ情報を特定するAPI-Keyが必要となります。

API-Keyは64文字の乱数の文字列となっております。利用する際は「カテゴリ管理者」権限のユーザを利用されている方に依頼して発行してください。

2-3. API一覧

本書の対象となるAPI機能は、以下の通りになります。

2-4. レポンスヘッダー

本APIから情報が返される際のレスポンスヘッダーのContent-Typeは以下になります。

　　Content-Type ： application/json

起動処理側で処理結果情報を取得する場合はjson形式の処理を確認してください。

2-5. 結果情報

APIの処理結果は全てのAPI処理に共通して返却用jsonデータの中に保存されています。

　処理結果情報Key名　：    code

　成功時Code値    　　 ：    000

失敗時Code値    　　 ：    失敗内容に伴うCode値が設定されます( 内容は各API資料に記載 )

3. インシデント登録

3-1. 機能説明

インシデント情報を登録します。

インシデント登録時のステータスは『新規』で、インシデント種別は『API起票』で登録されます。

また、インシデント対応履歴の1件目に『API連携によりインシデント自動発行』との対応履歴が作成されます。

3-2. 実行方法

{ EndPoint }/v1/incident_entry.php

3-3. パラメータ

実行時に必要なパラメータ情報(json形式)は以下となります。

• （実行例）受信アドレス【alert01@amf.paan.jp】に送信者【user01@amf.paan.jp】でインシデントを登録する。

{
  "key" : "[API-Key情報]",
  "title" : "[インシデント件名情報]",
  "msg" : "[インシデント本文]" ,
  "address" : "alert01@amf.paan.jp",
  "from" : "user01@amf.paan.jp"
}

3-4. 結果データ

処理終了時に以下の情報をjson形式で返却します。

codeで返される値の情報は以下になります。

• （結果例）インシデント登録が正常終了し、インシデントID9999で登録された場合

{
  "code" : "000",
  "id" : "00009999"
}

4. インシデントステータス更新

4-1. 機能説明

指定されたインシデントのステータスを変更します。

指定したステータスに変更できる事からインシデントのクローズ等をAMFにログインする事なく、

自動で対応する事も可能です。

4-2. 実行方法

{ EndPoint }/v1/incident_status.php

4-3. パラメータ

実行時に必要なパラメータ情報(json形式)は以下となります。

stateで設定可能なステータスIDは以下になります。

• 実行例( インシデントID【1000】のステータスを【完了】に変更する )

{
  "key" : "[API-Key情報]",
  "id" : "1000",
  "state" : "3"
}

4-4. 結果データ

処理終了時に以下の情報をjson形式で返却します。

codeで返される値の情報は以下になります。

• 結果例( インシデントのステータス更新処理が正常に終了した場合の結果データ )

{
  "code" : "000"
}

5. インシデント詳細

5-1. 機能説明

指定したインシデント情報を取得します。

インシデント情報を取得できる事からAMFにログインする事なくインシデント情報の二次利用が可能となります。

5-2. 実行方法

{ EndPoint }/v1/incident_dtl.php

5-3. パラメータ

実行時に必要なパラメータ情報(json形式)は以下となります。

• 実行例( インシデントID【1000】の情報を取得する )

{
  "key" : "[API-Key情報]",
  "id" : "1000"
}

5-4. 結果データ

処理終了時に以下の情報をjson形式で返却します。

codeで返される値の情報は以下になります。

dataで返されるインシデント情報の連想配列の情報は以下になります。

• 結果例( インシデント情報の取得に成功した場合の結果データ )

{
  "code": "000",
  "data": {
    "cust_name": "[カテゴリ名（旧顧客名）]",
    "addr_name": "[受信アドレス名]",
    "from_addr": "[送信元メールアドレス]",
    "alert_date": "YYYY-MM-DD HH:MI:SS",
    "state_name": "新着",
    "title": "[インシデント件名]",
    "kind_name": "API起票",
    "alert_data": "[インシデント本文]",
    "incident_size": "999"
  }
}

6. インシデント一覧

6-1. 機能説明

インシデント一覧情報を取得します

取得できる情報はAMF画面上の検索条件と同等の内容が選択できます

6-2. 実行方法

{ EndPoint }/v1/incident_list.php

6-3. パラメータ

実行時に必要なパラメータ情報(json形式)は以下となります。

termで設定できるインシデント検索条件情報の連想配列の情報は以下になります。

• 実行例( インシデントが2018/5/25に種別API起票された最新20件のデータを取得する )

{
  "key": "[API-Key情報]" ,
  "term": {
    "kind_flg" : "4",
    "start_date" : "2018/5/25",
    "end_date" : "2018/5/25",
    "data_cnt" : "20",
    "page_no" : "1"
  }
}

6-4. 結果データ

処理終了時に以下の情報をjson形式で返却します。

codeで返される値の情報は以下になります。

dataで返されるインシデント一覧情報の連想配列の情報は以下になります。

行番号で返されるデータ内容の連想配列の情報は以下になります。

• 結果例( インシデント一覧の取得に成功した場合の結果データ )

{
  "code": "000",
  "max_cnt": "22",
  "cnt": 20,
  "data": {
    1: {
      "incident_id": "9999",
      "alert_date": "YYYY-MM-DD HH:MI:SS",
      "recieve_address": "[受信アドレス名]",
      "from_addrress": "[送信元メールアドレス]",
      "title": "[インシデント件名]",
      "state_name": "新着",
      "filter_name": "[処理フィルタ情報]",
      "send_user": null
    },
    2: {
       …
    }
  }
}

7. 受信アドレス一覧

7-1. 機能説明

ユーザが権限を所有している受信アドレス一覧情報を取得します。

7-2. 実行方法

{ EndPoint }/v1/address_list.php

7-3. パラメータ

実行時に必要なパラメータ情報(json形式)は以下となります。

• 実行例( API-Key情報が権限を所持する受信アドレス一覧を取得する )

{
  "key" : "[API-Key情報]"
}

7-4. 結果データ

処理終了時に以下の情報をjson形式で返却します。

codeで返される値の情報は以下になります。

dataで返されるインシデント一覧情報の連想配列の情報は以下になります。

行番号で返されるデータ内容の連想配列の情報は以下になります。

• 結果例( 受信アドレス一覧の取得に成功した場合の結果データ )

{
  "code": "000",
  "cnt": 2,
  "data": {
    1: {
      "name": "[受信アドレス名]",
      "address": "[受信メールアドレス]"
    }
  }
}