メインコンテンツまでスキップ

外部連携メニューガイド

※ 最終更新: 2025-05-21

SHIELD Mail 外部連携メニューでは、特定の条件に応じてメール処理時に外部システムとのデータ連携を設定できます。

このメニューを通じて、特定のヘッダー値が含まれたメールを受信した場合、指定されたAPIにデータを送信することができます。

1. 外部連携メニューへの進入​

設定 > API 連携メニューから外部連携管理画面にアクセスできます。

api

  • 初期画面では、登録された連携がない場合、空の画面が表示されます。
  • API 연동 추가ボタンをクリックして新しいAPI連携設定を開始できます。

2. API 連携登録する​

API統合を追加するにはAPI 연동 추가ボタンをクリックします。

  • **イベントタイプ（必須）：**現在サポートされているイベントタイプは메일 수신됨です。
    • MAIL_RECEIVE: メール受信時のイベントトリガー
  • **ヘッダーキー（必須）：**メールヘッダーで特定のフィールドを指定します。例:x-sentmail-sync
  • **ヘッダー値 (必須):**指定されたヘッダーキーに一致する値です。例:yes
  • **対象URL（必須）：**API呼び出しが行われるエンドポイントURLを入力します。
  • **再試行設定:**API呼び出しの失敗時に再試行回数と間隔を設定できます。
    • 最大再試行回数: デフォルト値3회
    • 再試行間隔 (分): デフォルト値1분
  • **有効化の有無:**登録されたAPI連携の活性化の有無を設定します。

設定完了後、저장ボタンをクリックして連携情報を保存します。

3. API 連携一覧​

API連携が登録されると、メイン画面に連携リストが表示されます。

  • 連携名、イベントタイプ、ヘッダーキー、ヘッダー値、対象URL、アクティブ状態が表示されます。
  • 各項目をクリックして편집または삭제できます。

4. 接続テスト​

API連携が登録された後、設定が正常に動作しているか確認するために연결 테스트機能を提供します。

  • 연결 테스트ボタンをクリックすると、APIが呼び出され、設定されたヘッダーキーと値が送信されます。
  • 接続成功時:연결 성공メッセージとともに接続時間を表示
  • 接続失敗時:연결 실패メッセージ表示
    • エラー詳細情報のサポート予定

5. 注意事項および推奨事項​

  • 連携名と対象URLは必須入力項目です。
  • 再試行設定はAPIサーバーの応答時間に合わせて適切に調整する必要があります。
  • ヘッダーキーとヘッダー値は、イベントがトリガーされるために正確に一致する必要があります。

6. 注意事項​

  • 現在MAIL_RECEIVEイベントタイプのみサポートされています。
  • 追加のイベントタイプ (MAIL_SEND, FILE_CONVERTは今後開発予定です。
  • API呼び出し時の応答時間は10秒に制限されています。超過した場合は타임아웃エラーが発生しました。

内部文書リンク​

更新予定です。