【弊社製アプリのOAuth認証切り替え】トリガ設定の変更を行う

これまで、一部の弊社製アプリではAPIトークンを使用して認証を行っていましたが、Zendesk社の機能アップデートにより、OAuthクライアントを使用した認証方式へ移行することが必要となります。

アプリによって、対応手順は異なります。弊社製アプリの移行対応について、全体的な方針を確認したい場合はエクレクト製アプリをご利用中のお客さまへをご参照ください。

この記事では、Media SMS Channel Integration、Attachment Encryption、LINE Channel Integration、Slack Channel Integration、楽天あんしんメルアド連携をご利用中のお客様向けの手順をご案内します。

本手順の対象となるアプリ一覧

赤枠内のアプリをご利用中のお客さまは、本記事を参照しながら対応を行ってください。

認証切り替え手順

切り替えには以下の手順が必要です。この記事では手順2をご案内します。

手順1) Zendesk OAuthクライアントを作成する

管理センターでOAuthクライアントを作成し、必要情報を弊社にご連絡ください。

詳細な手順は、別記事「Zendesk OAuth Clientの作成方法」をご参照ください。

弊社製の他のアプリの移行対応のために、すでにOAuthクライアントを作成済みの場合は、改めて作成しなくても結構です。「弊社製アプリ用」として、まとめて1つのOAuthクライアントを作成ください。

手順2) 登録済みのWebhook設定を確認する

管理センターにて、[アプリおよびインテグレーション] > [Webhook]へアクセスします。

各Webhook設定をクリックして、「エンドポイント」にapp.eclect.jpが含まれているすべてのWebhookについて、設定画面のURLを手元に控えてください。

▼URL...webhook/[ID]/detailsの[ID]部分を弊社側サーバーに登録します。

手順3) OAuthクライアントとWebhookのURL情報を弊社へ提供する

手順1と手順2で取得した情報をこちらのGoogleフォームより弊社宛にご提供ください。

手順4) トリガのJSON bodyを更新する

お客さまより共有いただいた情報を弊社サーバーに登録します。その後、登録済みのトリガ設定のJSON body記述を更新してください。

詳細手順

1. 弊社にてOAuthクライアント・Webhook情報を登録後、お客さまへ登録完了のご連絡をいたします。
   必ず弊社からに完了連絡を受け取ったあとに、以降の手順を進めてください。
2. お客さまにて、管理センターへアクセスしサイドバーの［オブジェクトとルール］より［ビジネスルール］>［トリガ］を選択します。
3. 対象アプリ用に登録されたトリガをクリックします。
   トリガ内の「アクション」に記述しているJSON bodyにて、support_api_tokenを削除して更新します。

対象トリガの特定とJSONサンプル

対象アプリによっては、複数のトリガを変更する必要があります。変更が必要なトリガを特定し、漏れなく変更してください。

変更作業はsupport_api_tokenの記述削除ですが、削除対応後のJSON bodyのサンプルを掲載します。どのトリガを変更すべきか分からない、あるいはどのようにJSON bodyを変更すべきか分からない場合に、ご参照ください。

JSON bodyは、導入時期やお客様の環境によって、既存の設定内容が下記と一部異なる場合がございます。掲載しているサンプルをそのままコピー&貼り付けするのではなく、必ず現在登録されている記述との差分を比較してからご利用ください。

■ Media SMS Channel Integration

連携方法として、単方向・双方向連携の２種類があります。いずれかのトリガが登録されているので、ご変更をお願いします。

また「ユーザー統合」処理を行っている場合があります。ユーザー統合用のトリガがあれば、こちらもご変更ください。

単方向連携用のJSON body：

  {
      "zendesk_subdomain":"[サブドメイン]",
      "sender_phone":"[送信元電話番号]",
      "comment":"{{ticket.latest_public_comment}}",
      "requester_id":"{{ticket.requester.id}}",
      "end_user_phone": "{{ticket.ticket_field_[チケットフィールドID]}}",
      "ticket_id": "{{ticket.id}}",
      "use_channel_integration": false
    }

双方向連携用のJSON body：

  {
      "zendesk_subdomain":"[サブドメイン]",
      "sender_phone":"[キャリア共通番号]",
      "comment":"{{ticket.latest_public_comment}}",
      "requester_id": {{ticket.requester.id}},
      "end_user_phone": "{{ticket.ticket_field_[チケットフィールドID]}}",
      "use_channel_integration": true
    }

ユーザー統合用のJSON body：

{
  "user_id": "{{ticket.requester.id}}",
  "user_field_name": "phone",
  "any_channel_name": "Media SMS",
  "use_international_phone_number": "+81",
  "user_field_result": {
    "name": "is_merged",
    "value": true
  },
  "zendesk_subdomain": "[サブドメイン]"
}

※[サブドメイン],[送信元電話番号],[チケットフィールドID]の部分はご利用環境ごとに異なる記述となっています。

■ Attachment Encryption（添付ファイルパスワード）

Attachment Encryption用のJSON body：

{
  "ticket_id": "{{ticket.id}}",
  "zendesk_subdomain": "[サブドメイン]",
  "comment_for_file": "{{ticket.requester.name}} 様\n\n本メール添付のデータをご確認くださいませ。\nなお、開封用パスワードは別途お送りします。",
  "comment_for_password": "{{ticket.requester.name}} 様\n\n先程、お送りしました添付ファイルの開封用パスワードは以下の通りです。\n\n添付ファイル名： {}\n開封用パスワード： {}\n\n本メールは自動送信によりお送りしております。",
  "comment_mode_public": false
}

※[サブドメイン]の部分はご利用環境ごとに異なる記述となっています。

■ LINE Channel Integration

「ユーザー統合」処理を行っている場合があります。ユーザー統合用のトリガがあれば、こちらもご変更ください。

LINE連携用のJSON body：

{
  "requester_id": "{{ticket.requester.id}}",
  "comment":"{{ticket.latest_public_comment}}",
  "any_channel_name": "LINE",
  "user_field_name": "line_ids",
  "line_bot_id": "[Bot user ID]",
  "zendesk_subdomain": "[サブドメイン]",
  "line_group_id": "{{ticket.ticket_field_[チケットフィールドID]}}"

ユーザー統合用のJSON body：

{
  "user_id": "{{ticket.requester.id}}",
  "user_field_name": "line_ids",
  "any_channel_name": "LINE",
  "user_field_result": {
    "name": "is_merged",
    "value": true
  },
  "zendesk_subdomain": "[サブドメイン]"
}

※[サブドメイン],[チケットフィールドID],[Bot user ID]の部分はご利用環境ごとに異なる記述となっています。

■ Slack Channel Integration

Slack連携を行っていても、「ユーザー統合」処理を行っていない場合は対応不要です。ユーザー統合用のトリガがあればご変更ください。

ユーザー統合用のJSON body：

{
  "user_id": "{{ticket.requester.id}}",
  "user_field_name": "email",
  "channel_user_field_name": "slackemail",
  "user_field_result": {
    "name": "merge_check",
    "value": true
  },
  "user_fields_copy": {
    "overwrite": [
      "slackid",
      "slackusername",
      "slackemail"
    ],
    "if_empty": [
      "slackrealname"
    ]
  },
  "zendesk_subdomain": "[サブドメイン]"
}

※[サブドメイン]の部分はご利用環境ごとに異なる記述となっています。

■楽天あんしんメルアド連携

「チケット統合」の処理をトリガで行っています。

チケット統合用のJSON body：

{
  "comment": {
    {% for comment in ticket.comments limit:1 offset:0 %}
    "body":"{{comment.value}}",
    "author_id":"{{comment.author.id}}",
    "has_attachment": "{% for attachment in comment.attachments limit:1 offset:0 %}{{attachment.url}}{% endfor %}"
	 {% endfor %}
  },
  "ticket_id_from": "{{ticket.id}}",
  "zendesk_subdomain": "[サブドメイン]",
  "oauth_client_id": "[OAuthクライアント識別子]",
  "ticket_id_prefix": "送信チケットID："
}

※[サブドメイン],[OAuthクライアント識別子]の部分はご利用環境ごとに異なる記述となっています。