目次

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はAMFユーザごとに発行可能で、発行可能な権限は「カテゴリ管理者」です。
利用する際は、「カテゴリ管理者」権限ユーザを利用されている方に依頼して発行ください。

2-3. リクエストヘッダー

リクエストヘッダーは、以下の通り指定してください。

2-4. API一覧

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

3. API詳細

3-1. インシデント登録

・説明

インシデントを登録します。
登録時のステータスは『新規』で、インシデント種別は『API起票』で登録されます。
登録後、メール受信による登録と同様に、フィルタ・アクションが実行されます。
また、インシデント対応履歴の1件目に『API連携によりインシデント自動発行』との対応履歴が登録されます。

・パス

/v2/incident_entry.php

・リクエストパラメータ

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

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

・レスポンスデータ

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

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

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

3-2. インシデントステータス更新

・説明

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

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

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

・パス

/v2/incident_status.php

・リクエストパラメータ

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

（例）インシデントID【1000】のステータスを【完了】に変更する 

{
  "id" : "1000",
  "state" : "3"
}

・レスポンスデータ

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

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

{
  "code" : "000"
}

3-3. インシデント詳細

・説明

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

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

・パス

/v2/incident_dtl.php

・リクエストパラメータ

（例）インシデントID【1000】の情報を取得する 

{
  "id" : "1000"
}

・レスポンスデータ

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"
  }
}

3-4. インシデント一覧

・説明

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

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

・パス

/v2/incident_list.php

・リクエストパラメータ

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

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

{
  "term": {
    "kind_flg" : "4",
    "start_date" : "2018/5/25",
    "end_date" : "2018/5/25",
    "data_cnt" : "20",
    "page_no" : "1"
  }
}

・レスポンスデータ

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

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

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

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

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

3-5. 受信アドレス一覧

・説明

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

・パス

/v2/address_list.php

・リクエストパラメータ

なし

・レスポンスデータ

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

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

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

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

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