Zoho OAuthへの切り替え方法
現在、Zohoサービスでは認証方法としてZoho OAuthが使用されています。 このページでは、認証方法を以前の方法である認証トークンからZoho OAuthに切り替える方法について説明します。
APIの直接実行
Zoho DeskのAPIを直接実行するアプリケーションを作成している場合、移行APIを通じて認証トークンをZoho OAuthに移行することができます。
作成したアプリケーションの種類に応じて、以下から適切な方法を選択して実施してください：
作成したアプリケーションの種類に応じて、以下から適切な方法を選択して実施してください：
1. Webアプリケーションの移行方法： APIを利用しているアプリケーションが複数のユーザーによって使用されていて、認証トークンの生成にユーザー情報が使用されている場合、次の手順で移行を実施します：
-
サポートチームによる確認後、次のAPIを使用して移行処理を完了します。
|
移行APIのサンプル
https://accounts.zoho.com/oauth/v2/token/external/authtooauth?client_id=%3COAuth のクライアントID>&client_secret=<OAuthのクライアントシークレット>&grant_type=authtooauth&authtoken=<移行対象の認証トークン>&soid=ZohoSupport.<
Zoho Deskポータルの組織ID>
APIリクエストのサンプル
&authtoken=a99 fxxxxxxxxxxx215&soid=ZohoSupport. 1234567
リクエストの種類
POST
レスポンスのサンプル
{
"access_token": "1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf",
"refresh_token": "1000.b8xxxxxxxxxxxxxxxx58f.538b3xxxxxxxxxxxxxxxxx114",
"expires_in_sec": 3600,
"token_type": "Bearer",
"expires_in": 3600000
}
メモ
このAPIの実行後、事前に共有された詳細情報を基に、サポートチームによってこのAPIの詳細情報が検証されます。事前に共有された詳細情報と実行されたAPIの詳細情報が一致しない場合、APIは実行されません。そのため、詳細情報が正しく入力されていることを確認してください。移行前に使用していた認証トークンは、移行後24時間経過すると削除されます。 |
2. 独自のクライアントアプリケーションの移行方法： 利用中の認証トークンを自社で管理している場合（自社において認証トークンを用いて処理を実行するためのシステムを運用している場合）、認証トークンをZoho OAuthに直接移行することができます。サポートチームへの連絡は必要ありません。次の手順で移行を実施します：
|
移行APIのサンプル
https://accounts.zoho.com/oauth/v2/token/self/authtooauth?client_id=%3COAuth のクライアントID>&client_secret=
<OAuthのクライアントシークレット>&grant_type=authtooauth&authtoken= <移行対象の認証トークン >&scope=<スコープ>&soid=ZohoSupport.<Zoho Deskポータルの組織ID>
APIリクエストのサンプル
https://accounts.zoho.com/oauth/v2/token/self/authtooauth? client_id=1000.T9GxxxxxxxxxxxxxxxxxTS&client_secret=e9xxxxxxxxxxxxxxxxxxxxxx798&grant_type=
authtooauth&authtoken= feexxxxxxxxxxxxxxxxxxxf59e&scope= Desk.tickets. ALL&soid=ZohoSupport.123467
リクエストの種類
POST
レスポンスのサンプル
{
"access_token": "1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
"refresh_token": "1000.95xxxxxxxxxxxxxxxb0de.10bxxxxxxxxxxxxxxxxxx31b",
"expires_in_sec": 3600,
"token_type": "Bearer",
"expires_in": 3600000
}
メモ
このAPIの実行後、認証情報を適切に設定するために、Zoho OAuthに登録されているIDと認証トークンのアカウント情報が照合されます。移行前に使用していた認証トークンは、移行後24時間経過すると削除されます。
|
カスタム関数
カスタム関数内における認証を、認証トークンからOAuthに変更する場合は、外部連携の設定を使用します。外部連携の設定を通じて、OAuthに簡単に移行できます。カスタム関数内で外部連携の認証を変更する方法は、次のとおりです。次の3つの手順で実行できます：外部連携の作成、認証トークンパラメーターの削除、外部連携パラメーターの追加。
- 上部メニューの 設定 アイコン（
）をクリックします。
- ［開発者向け情報］ の ［外部連携］ をクリックします。
［My Connections］ （自分の外部連携）の画面が開き、設定済みの外部連携の一覧が表示されます。 - 画面右上にある ［Create Connection］ （外部連携を作成する）ボタンをクリックします。
- ［Create Connection］（外部連携の作成）画面で、 サービスの種類 を選択します。
- ［Connection Name］ （外部連携名）と ［Connection Link name］ （外部連携のリンク名）を入力します。
- アプリケーションの利用条件に応じて、 スコープ を選択します。
- ［Create and Connect］ （作成して連携する）をクリックします。
概要ページに、外部連携の リンク名 、 サービス名 、 ステータス が表示されます。
手順2：認証トークンのパラメーターの削除
- 既存の関数コード内の認証トークンのパラメーターを削除します（下図参照）。
手順3：外部連携のパラメーターの追加
- 「invokeurl」メソッド内に「connection」パラメーターを追加し、手順1で入力した 外部連携のリンク名 を指定します（下図参照）。
- ［Save & Execute Script］ （保存してスクリプトを実行する）をクリックします。
これで、カスタム関数内の認証で、認証トークンの代わりに、外部連携が使用されるようになります。
外部連携
外部連携における認証に、認証トークンが使用される場合があります。このような外部連携については、 OAuth を使用するように設定を変更することをお勧めします。 変更手順は、次のとおりです：
- 上部メニュの 設定 アイコン（
- ［開発者向け情報］ の ［外部連携］ をクリックします。
［My Connections］ （自分の外部連携）の画面が開きます。一覧内の非推奨の認証トークンが使用された外部連携には、 ［Expiring Soon］ （まもなく利用できなくなります）というメッセージが表示されています。
- 対象の外部連携にカーソルを合わせ、 ［Migrate To OAuth］ （OAuthに移行する）をクリックします。
-
［Edit Connection］（外部連携の編集）画面で、APIの呼び出しに必要なスコープを選択します。
メモ：
外部連携名を変更した場合、外部連携が使用されているすべての場所で、新しい名前に変更する必要があります。
- ［Update］ （更新する）をクリックします。
これにより、外部連携の認証が、認証トークンからOAuthに変更されます。
外部アプリケーションとマーケットプレイスのアプリケーション
認証プロセスに認証トークンを使用するアプリケーションを開発していた場合、Zoho OAuthに移行する必要があります。Zoho Marketplaceでアプリケーションを作成した場合、外部連携を利用することで既存の認証トークンをZoho OAuthに移行することができます。Zoho Marketplaceのアプリケーションに関する認証の設定方法については、 こちら をご参照ください。外部連携の設定後、外部連携からJSONレスポンスをコピーしてアプリケーションの「plugin-manifest.json」ファイルに貼り付けます。
外部サービスのアプリケーションを開発した場合、既存の認証方法をZoho OAuthに移行する必要があります。外部連携を使用した移行は、Zoho Marketplaceに表示されているアプリケーションでのみ可能です。
アプリケーションユーザーの場合、認証方法を変更できるのはアプリケーションの開発者のみですのでご注意ください。認証方法の変更後、アプリケーションを更新して再認証した上で、すべての権限が適切に設定された状態で正しく機能するか確認する必要があります。