接続情報 - Zendesk Support

概要

Zendesk Supportの接続情報を設定する際のDocsとなります。

APIトークン認証・パスワード認証の廃止

ZendeskのAPIトークンは、段階的に廃止されます。
メール・パスワード認証は、すでに廃止されています。

今後は、OAuth 2.0認証を利用してください。
廃止の対象や日程は、Zendeskヘルプセンター - Announcing the removal of API tokens as an authentication method for API requestsを参照ください。

項目名	必須	内容
名前	✓	TROCCO内部で利用する接続情報の名前を入力します。
メモ	-	TROCCO内部で利用する接続情報のメモを入力します。
URL	✓	ZendeskのURLを入力します。詳しくは、URLの確認方法を参照ください。
認証方式	✓	認証方式を選択します。詳しくは、認証方式を参照ください。
Zendeskアカウント	✓	アカウントを認証するをクリックし、Zendeskアカウントを認証します。詳しくは、OAuth 2.0認証の手順を参照ください。

Zendeskアカウントは、認証方式にOAuth 2.0認証を選択した場合に表示されます。
認証方式に非推奨の認証方式を選択している場合は、ユーザー名と、選択した認証方式に応じた項目（APIトークンまたはパスワード）が表示されます。

Zendeskにログインします。
ログインした際のURLがhttps://<subdomain>.zendesk.com/のようになっている場合、接続情報のURLにはhttps://<subdomain>.zendesk.com/api/v2を入力します。

Zendesk Support接続情報では、以下の認証方式を利用できます。

認証方式	内容
OAuth 2.0認証	TROCCOのOAuthアプリケーションをZendeskアカウントで認可します。 Zendesk側でのAPIトークンの発行は不要です。
APIトークン (非推奨)	Zendeskで発行したAPIトークンを利用します。 Zendeskによる廃止の対象であり、非推奨です。新規作成時は選択できません。
パスワード (非推奨)	Zendeskのメールアドレスとパスワードを利用します。 Zendeskによってすでに廃止されており、非推奨です。新規作成時は選択できません。

同じZendeskアカウントを利用する場合も、接続情報ごとに認証が必要です。

URLとZendeskアカウントのサブドメイン

URLのサブドメインと、OAuth 2.0認証で認証したZendeskアカウントのサブドメインは、一致している必要があります。
一致していない場合、接続情報を保存できません。

アカウントを認証するボタンがクリックできない場合

URLがhttps://<subdomain>.zendesk.comで始まる形式で入力されていない場合、アカウントを認証するはクリックできません。
先にURLを入力してください。

OAuth認証の有効期限

リフレッシュトークンには、有効期限があります。
TROCCOでは、リフレッシュトークンを使用してアクセストークンを自動的に更新するため、通常は再認証の必要はありません。

ただし、長期間にわたって転送ジョブが実行されなかった場合は、再度認証が必要になります。
ジョブログに再認証を促すメッセージが出力された場合は、接続情報の編集画面でアカウントを再認証するをクリックし、あらためてZendeskアカウントを認証してください。

APIトークン認証またはパスワード認証を利用している接続情報は、編集画面からOAuth 2.0認証へ変更できます。
変更の手順は、OAuth 2.0認証の手順と同じです。

認証方式の変更は元に戻せません

OAuth 2.0認証へ変更して保存すると、変更前の認証情報（APIトークンまたはパスワード）は削除されます。
以降、元の認証方式には戻せません。

新規に接続情報を作成する場合は、OAuth 2.0認証のみ利用できます。

既存の接続情報でAPIトークン認証を利用するには、Zendesk側で以下の設定が必要です。