OAuth 2.0への移行方法
このページでは、リダイレクトを用いたアプリケーションや独自のクライアントアプリケーションにおける既存の認証トークンの更新方法について説明します。APIバージョン1.1を使用できる条件は、次のとおりです：
- 複数のユーザーによってアプリケーションが使用されており、認証トークンの生成にユーザー名とパスワードが使用されている場合
- ユーザーが自身の認証トークンを入力している場合
リダイレクトを用いたアプリケーションの移行方法
前提条件
アプリケーションの所有者は、クライアントID、認証トークンのスコープ、対象のOAuthのスコープの情報をsupport@zohocampaigns.comに送信する必要があります。送信された情報がZoho Campaignsチームによって検証され、この情報を基にZoho Accountsで設定が行われます。検証の完了後、更新情報についてアプリケーションの所有者にメール通知が送信されます。
移行方法
リダイレクトを用いたアプリケーションの移行処理は、段階的に行います。
- Zoho Campaignsチームによる検証後、クライアントID、クライアントシークレット、認証トークンを使用して外部アプリケーションから移行APIを実行します。
- リクエスト内のパラメーターがすでに検証済みかどうかZoho Accountsによって検証が行われます。
- 検証の完了後、Zoho AccountsによってOAuthへのアクセスが許可され、アプリケーションのトークンが更新されます。
リクエストURL
リクエストのメソッド
POST
パラメーター
パラメーター | データの種類 | 説明 |
client_id | 文字列 | アプリケーションの登録時に取得したクライアントIDを指定します。 |
client_secret | 文字列 | 接続するアプリケーション用に生成されたクライアントシークレットを指定します。 |
grant_type | 文字列 | 値は「authtooauth」にする必要があります。 |
authtoken | 文字列 | 使用中の認証トークンを指定します。 |
主なエラー
エラーコード | 説明 |
invalid_grant | 「grant_type」が「authtooauth」と指定されていません。 |
invalid_client | 指定したクライアントIDが正しくありません。 （または） 有効なクライアントに対する認証トークンとOAuthとの関連付けが、Zoho Accountsで行われていません。 |
invalid_authtoken | 指定した認証トークンが無効です。 （または） 認証トークンのスコープと共有された認証スコープが一致しません。 |
invalid_scope | 指定したOAuthのスコープが無効です。 |
メモ：
- 実行可能な移行リクエストの上限は、1分間につき60件または1時間につき100件までです。
- 以前の認証トークンは、OAuthトークンが生成された次の日にシステムによって削除されます。
- クライアントによる認証トークンの指定の試行回数は、20回までです。この上限を超えると、システムによってクライアントがブロックされ、「access_denied」とエラーメッセージが表示されます。
独自のクライアントアプリケーションの移行方法
アプリケーションがサーバー上で独立して動作していて、ドメインやリダイレクトURLを設定していない場合、この移行方法に沿って設定することができます。
移行方法
独自のクライアントアプリケーションの移行処理は、段階的に行います。
- クライアントID、クライアントシークレット、認証トークン、対象のOAuthのスコープを使用して外部アプリケーションから移行APIを実行します。
- 認証トークンサービス名とOAuthのスコープが一致しているかどうかZoho Accountsによって検証が行われます。
- スコープの検証後、アプリケーションの所有者と認証トークンの所有者が同じかどうかZoho Accountsによって検証が行われます。
- 検証の完了後、Zoho Accountsによって外部アプリケーション用のOAuthトークンが生成されます。検証に失敗すると、システムによって「access_denied」とエラーメッセージが表示されます。
- Zoho Accountsから更新情報に関する通知がメールで送信されます。
リクエストURL
リクエストのメソッド
POST
パラメーター
パラメーター | データの種類 | 説明 |
client_id | 文字列 | アプリケーションの登録時に取得したクライアントIDを指定します。 |
client_secret | 文字列 | 接続するアプリケーション用に生成されたクライアントシークレットを指定します。 |
grant_type | 文字列 | 値は「authtooauth」にする必要があります。 |
authtoken | 文字列 | 使用中の認証トークンを指定します。 |
scope | 文字列 | Zoho CampaignsのデータにアクセスするOAuthのスコープを指定します。Zoho Campaignsのスコープの詳細については、Zoho CampaignsのREST APIのヘルプに記載されている認証トークンのセクションをご参照ください。 |
主なエラー
エラーコード | 説明 |
invalid_grant | 「grant_type」が「authtooauth」と指定されていません。 |
access_denied | 指定した認証トークンがすでにOAuthトークンの生成に使用されています。 |
invalid_client | 指定したクライアントIDが正しくありません。 |
invalid_authtoken | 指定した認証トークンが無効です。 |
invalid_scope | 指定したOAuthのスコープが無効です。 |
メモ：
- 実行可能な移行リクエストの上限は、1分間につき25件または1時間につき60件までです。
- 以前の認証トークンは、OAuthトークンが生成された次の日にシステムによって削除されます。
Zoho CRM 管理者向けトレーニング
「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。
日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Zoho WorkDrive Resources
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
Related Articles
Zoho CRM連携の新しい連携方式への移行
Zoho CampaignsとZoho CRMの連携方式が新しくなりました。新しい連携方式では、従来と比較して、同期機能において重要な変更が行われています。新バージョンの特徴は以下のとおりです。 すべての同期がすぐに実行されます。Zoho CRMとZoho Campaignsの間で定期的にデータが同期されるため、サービス間でデータの不整合が発生しません。 同期設定を1件作成するだけで、Zoho CRMの各タブから連絡先を同期できます（対象：見込み客／連絡先／カスタムタブ）。これにより、Zoho ...トピックの新バージョンへの移行
トピック管理の機能が新しくなりました。旧バージョンからの主な変更点は、以下のとおりです。 連絡先のデータを組織単位で管理できます（旧バージョンでは、連絡先を配信リストに追加する必要がありました）。 連絡先が配信メールの受信登録を解除すると、該当の連絡先は組織から登録が解除されます。 組織で追加した連絡先は、標準のトピック（マーケティング対象）に自動で関連付けられます。 組織ですでにトピックが設定されている場合 既存のトピックは、新しいバージョンに移行されます。 ...連携設定の新バージョンへの移行
この度、Zoho Campaignsと他のアプリとの連携機能が新しくなりました。そのため、Zoho Campaignsと他のアプリ（Zohoサービス／外部サービス）との間での連絡先データの同期機能を引き続き利用する場合は、連携機能を新バージョンに移行してください。 この記事では、新バージョンでの一般的な変更点と、特定のアプリ（サービス）との連携に関する変更点について説明します。 関連情報：Zoho CRM連携の同期設定の新バージョンへの移行 移行によるメリット ...配信元API
配信元APIとは、認証方法を利用してZoho Campaigns Email APIと外部アプリを連携し、APIを通じてメールを配信するための連携の仕組みです。連携方法として、REST APIとSMTP APIの両方に対応しています。Zoho Campaigns Email APIでは、認証方法としてOAuth 2.0が使用されます。 OAuth 2.0 OAuth ...Zoho Campaigns Email APIの利用
Zoho Campaigns Email APIとは Zoho Campaigns Email APIとは、API（Application Programming Interface）を通じてメール配信関連の処理を実行するためのアプリです。メールの配信や配信状況に関するレポートの作成など、さまざまな操作を行うことができます。 Zoho Campaigns Email APIの利用を開始するにあたっては、Zohoアカウントを作成する必要があります。 Zoho Campaigns Email ...