接続の理解

接続の理解

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

1. このページの内容

Zoho Developer Consoleで、アプリケーションをZohoやその他の外部サービスに接続するためのコネクションと、対応している種類について説明します。
Idea

2. 利用条件

作成、管理できるのは、特権管理者と開発者のみです。その他のユーザー（クライアント）は、自分のCreatorアカウントでコネクションを認証し、アクセスできます。

3. 概要

コネクションを使用すると、特権管理者や開発者は、アプリケーションを外部サービスと連携させ、配布対象のアプリで利用できるさまざまなクラウドベースのリソースにアクセスできます。コネクションは、異なるシステム間の通信を認証、承認するために使用され、外部ツールやサービスを取り込むことでアプリの機能を拡張します。

4. 使用例

開発者は、限定配布またはMarketplace公開向けの不動産管理アプリを作成する際に、Developer Consoleを使用してコネクションを作成します。開発者側では、Zoho Booksとの管理者コネクションにより、売却済み物件の記録を送信して請求書を作成するなどのワークフローを自動化できます。また、Zoho Sheetsとのログインユーザーコネクションにより、ページパネルに販売済み物件数を表示するなど、ユーザーごとにカスタマイズされたデータ表示が可能になります。
公開後、クライアントはアプリをインストールし、コネクションを認証します。Zoho Booksコネクションは特権管理者または管理者が認証し、Zoho Sheetsコネクションは各ユーザーが自分のアカウントで認証します。

5. コネクションへの移動手順

Developer Consoleでコネクションにアクセスするには、［マイクロサービス］セクションに移動します。
Notes
メモ：現在、［マイクロサービス］セクションで利用できるのはコネクションのみです。

6. Developer Consoleのコネクション

Developer Consoleのコネクションは、Zoho Marketplaceからインストールされたアプリケーション、または限定共有で利用されるアプリケーションに対して、特権管理者や開発者が作成して共有します。これらのコネクションは特権管理者や開発者によって管理され、ユーザーがコネクション設定を行わなくても、外部サービスと簡単に通信できます。開発環境またはステージ環境でテストでき、配布時にまとめて組み込むことで、クライアントやMarketplaceユーザーにアプリを展開する際に、安全で用途に応じたアクセスを提供できます。
各コネクションは1つのアプリケーションに関連付けられ、どの時点でも1つのアプリに対してのみ有効にできます。アプリケーションに対してコネクションのアクセスが有効になり、そのコネクションが参照されると、無効にすることはできません。参照を削除しても、アプリとコネクションがアプリケーションとともに公開済みの場合、そのコネクションは有効なままです。この制限により、ユーザーにパッケージとして配布される際に、コネクションがそれぞれのアプリケーション専用の状態に保たれます。
コネクションは、アプリケーションが他のZohoサービスや外部サービスと通信するためのゲートウェイとして機能します。認証と承認のプロセス全体を処理し、対応サービス内のアカウントに接続できるようにします。
コネクションは、設定や使用方法のさまざまな側面に応じて、複数の観点で分類できます。一般的な分類は次のとおりです。
  • コネクションの種類 - 作成方法に基づく分類
  • コネクションモード - OAuth認証情報の管理方法に基づく分類
Notes
メモ：システムコネクションは、複数のアプリケーションが特定のコネクションにアクセスできる点で異なります。ユーザーコネクションとは異なり、アプリの公開プロセスの対象外であり、クライアントアカウントにまだ存在しない場合にのみ作成できます。すでに存在する場合は、同じコネクションが再利用されます。
コネクションは、次の場所で使用できます。
  1. SMSアクション
  2. フォームのワークフローで連携アクションを使用して外部サービスにデータを送信
  3. Delugeの連携タスク
  4. DelugeのinvokeUrlタスク
  5. ページパネル
Notes
メモ：Developer Consoleでサポートされているのは組み込みコネクターのみです。カスタムコネクターはこのバージョンではサポートされていません。

7. コネクションの種類 

Developer Consoleでは、コネクションの作成方法に基づいて、さまざまな種類のコネクションに対応しています。

  • システムコネクション

  • ユーザーコネクション

Notes
メモ：Developer Consoleの開発環境とステージ環境のライブモードでは、すべての種類のコネクションを特権管理者と開発者が認証できます。インストール済みのアプリケーションでこれらのコネクションを機能させるには、クライアントが認証する必要があります。

7.1 システムコネクション

システムコネクションは、アプリ内のワークフローなどのタスクでDeveloper Console内のサービスへのコネクションが必要になると、自動的に作成されます。これらのコネクションはクライアント側でもシステムによって作成され、Developer Consoleでアプリを公開する際には含まれません。必要なサービスへのシステムコネクションがユーザーのアカウントにすでに存在する場合は、そのコネクションが再利用されます。存在しない場合は、タスクの実行時に新しいコネクションが自動的に作成されます。これにより、システムコネクションは複数のアプリに対応し、必要な場合にのみ作成されるため、柔軟に利用できます。
たとえば、Zoho CRMのレコードを更新するワークフローを持つアプリを作成する場合を考えます。開発中、Developer Consoleの開発者は、Zoho CRM用に自動作成されたコネクションを利用してこの機能をテストできます。ただし、このコネクションは、Marketplaceまたは限定共有のクライアントへの配布プロセスには含まれません。クライアントがアプリをインストールし、ワークフローのルールが実行されると、システムはそのCreatorアカウント内に既存のZoho CRMシステムコネクションがあるかどうかを確認します。存在しない場合は、新しいシステムコネクションが自動的に作成されます。存在する場合は、手動設定を必要とせず再利用されます。

7.2 管理者コネクション

管理者コネクションは、クライアントアカウントの特権管理者または開発者によって認証され、通常ユーザーは個別に認証しなくても利用できます。これらのコネクションは1つの認証に関連付けられ、利用可能なサービスを使用して管理者が設定します。たとえば、Zoho CRMへの管理者コネクション（Developer Consoleで作成され、クライアントに配布されたもの）により顧客データを同期でき、注文の作成時にレコードを自動更新するなどのワークフローを実現できます。この一元的な認証により、アプリケーション内のすべてのユーザーがワークフローを実行できます。
Developer Consoleを通じて配布された場合、クライアント用の管理者コネクションは管理者コネクションとして保持されます。クライアントアプリの特権管理者と管理者が認証を管理し、すべてのユーザーに対してコネクションが機能し、安全に保たれるようにします。

7.3 ログインユーザーコネクション

ログインユーザーコネクション（Developer Consoleで作成され、クライアントに配布されたもの）は、ログインユーザーが個別に認証します。これらのコネクションにより、外部サービスとの個別連携が可能になり、ユーザーは特定のデータや機能にアクセスできます。たとえば、Zoho CRMのワークフローでは、各ユーザーが個人の認証情報を使用してコネクションを認証する必要があります。実行されると、データはユーザーのZoho CRMアカウントに送信されます。
Developer Consoleでは、これらのコネクションは公開ライフサイクル中に定義され、まとめて組み込まれます。配布後、クライアント環境のユーザーが個別に認証します。
ログインユーザーコネクションは、次の組み込みコネクターに対してのみ作成できます。
  1. QuickBooks
  2. Zoho CRM
  3. Zoho Recruit
  4. Clickatell
  5. Hoiio
  6. Clockwork SMS
  7. SMS-Magic
  8. Twilio
  9. Zoho OAuth
  10. Zoho Projects
  11. Zoho Sheets

8. コネクションモード

ユーザーコネクションを作成する際は、OAuth認証情報の管理方法を選択する必要があります。Zohoでは、次の2つのコネクションモードを提供しています。

  • Zoho管理のOAuthクライアント認証情報（クイック接続）

  • 独自のOAuthクライアント認証情報の使用（カスタム）

Zoho管理の認証情報     

Zoho管理のOAuth認証情報では、Zohoが作成、保守するOAuthアプリケーションを使用します。この標準の接続方法により、クライアントID、クライアントシークレット、リダイレクトURL、その他のOAuthコンポーネントなど、OAuthクライアントの設定やライフサイクルを手動で管理する必要がなくなります。OAuthアプリケーションは自動的に管理、保守されるため、ユーザー単位の同意とアクセス制御を維持しながら、最小限の設定で一般的な連携を簡単に認証できます。この方法は、次のようなシナリオに最適です。
  • OAuthアプリケーションの直接的な所有や管理が不要
  • 設定を簡素化し、メンテナンスの手間を軽減したい場合
  • 社内コンプライアンス要件を満たすために、Zohoが管理する認証情報の処理を利用する場合
たとえば、Google SheetsにアクセスするためにDeveloper Consoleで接続を作成する際、管理者／開発者はZoho OAuth認証情報を選択します。ZohoがOAuthアプリケーションをプロビジョニングして維持管理します。クライアントがアプリケーションをインストールすると、管理者がクライアントIDやシークレットを提供しなくても、サインインして権限を付与することでアクセスを承認できます。

クライアント認証情報 

クライアント認証情報を使用すると、開発者が作成して外部サービスに登録したOAuthアプリケーションを使用して、Developer Consoleで接続を設定できます。設定時に、開発者はサービスプロバイダーから発行されたクライアントID、クライアントシークレット、リダイレクトURL、その他のOAuth詳細情報を入力します。
この方式は一般的にBring Your Own Credential（BYOC）と呼ばれ、通常、認証の設定や管理方法をより細かく制御する必要がある組織で選択されます。OAuthアプリケーション自体は開発者が所有、管理しますが、承認はユーザーがアプリをインストールした後、自身のサービスアカウントを使用して行います。
この方法は、主に次のような場合に使用されます。
  • OAuthアプリケーションを直接所有および管理する場合
  • カスタマイズされた、または制限された承認スコープを定義できる場合
  • 社内のセキュリティ、コンプライアンス、規制ポリシーに準拠する必要がある場合
  • トークンのライフサイクル、アクセス権限、監査要件を管理する必要がある場合

9. 注意点

  1. 接続は、1つのアプリケーションにのみ関連付けることができます。
  2. システム接続は、クライアントアカウント内の特権管理者、管理者、開発者のみが承認できます。これらは公開サイクルには含まれず、サービスとの接続が存在しない場合に、クライアントがアプリケーションを使用すると作成されます。
  3. 配布前に、開発環境またはステージング環境ですべての接続を十分にテストし、アプリの機能を検証してください。
  1. 接続の作成と承認
  2. 接続の管理
  3. コネクターについて

次のステップ
前のステップ
次のステップ
接続が必要な理由と仕組みを理解したら、Developer Consoleで対応している各種コネクターについて学び、次にそれらを作成して承認する方法を確認します。
前のステップ
前のステップであるステージング環境への公開を理解したうえで接続を公開し、スムーズな導入プロセスを実現してください。