接続の概要

接続の概要

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

1. このページの内容

Zoho Developer Console でサポートされている各種コネクションについて学び、アプリケーションを Zoho や他のサードパーティサービスと接続する方法を確認できます。
Idea

2. 利用条件

コネクションの作成と管理ができるのはスーパー管理者と開発者のみです。他のユーザー（クライアント）は、自身の Creator アカウントでコネクションを承認し、利用できます。

3. 概要

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

4. 利用例

開発者が Developer Console を使って、不動産管理アプリをプライベート配布またはマーケットプレイス公開用に構築する際にコネクションを作成します。開発者側では、Zoho Books との管理者コネクションを利用して、売却済み物件レコードを請求書として作成するなどのワークフローを自動化できます。さらに、Zoho Sheets とのログインユーザーコネクションを利用すると、ページパネルに表示する「売却済み物件数」など、ユーザーごとにパーソナライズされたデータビューを提供できます。
アプリが公開されると、クライアントはアプリをインストールしてコネクションを承認します。スーパー管理者または管理者が Zoho Books のコネクションを承認し、各ユーザーは自分のアカウントで Zoho Sheets を承認します。

5. コネクション画面への移動方法

Developer Console でコネクションにアクセスするには、Microservices セクションに移動します。
Notes
メモ: 現時点では、Microservices セクションで利用できるのはコネクションのみです。

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 で作成し、クライアントに配布されるもの）は、ログインしている各ユーザーが個別に承認します。これらのコネクションにより、サードパーティサービスとの連携をユーザー単位でパーソナライズでき、特定のデータや機能へのアクセスをユーザーごとに付与できます。たとえば、Salesforce のワークフローでは、各ユーザーが自分の認証情報でコネクションを承認する必要があります。トリガーされると、データはそのユーザーの Salesforce アカウントに送信されます。
Developer Console では、これらのコネクションを定義し、公開ライフサイクルの中でバンドルします。配布後は、クライアント環境のユーザーがそれぞれ個別に承認します。
ログインユーザーコネクションを作成できるのは、次の組み込みコネクタのみです:
  1. Quickbooks
  2. Salesforce
  3. Zoho CRM
  4. Zoho Recruit
  5. Clickatell
  6. Hoiio
  7. Clockwork SMS
  8. SMS-Magic
  9. Twilio
  10. Zoho OAuth
  11. Zoho Projects
  12. Zoho Sheets

8. コネクションモード

ユーザーコネクションを作成する際は、OAuth 資格情報をどのように管理するかを選択する必要があります。Zoho では、次の 2 種類のコネクションモードを提供しています。

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

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

Zoho 管理の資格情報     

Zoho 管理の OAuth 資格情報では、Zoho によって作成・管理される OAuth アプリケーションを使用します。このデフォルトの接続方法を利用すると、クライアント ID やクライアントシークレット、リダイレクト URL などの OAuth コンポーネントを含む OAuth クライアントの設定やライフサイクルを手動で管理する必要がなくなります。OAuth アプリケーションは自動的に管理・維持されるため、ユーザーレベルの同意とアクセス制御を維持しつつ、最小限の設定で一般的な連携の認証を簡単に行えます。この方法は、次のようなケースに最適です。
  • OAuth アプリケーションを直接所有・管理する必要がない場合
  • セットアップを簡素化し、保守の手間を減らしたい場合
  • 内部コンプライアンス要件を満たすために、Zoho 管理の認証情報処理に依存したい場合
たとえば, Developer Console で Google スプレッドシートにアクセスするためのコネクションを作成する際、管理者／開発者は 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 でサポートされている各種コネクタについて学び、その後でコネクションをどのように作成して承認するかを確認してください。
前のステップ
コネクションを公開し、スムーズにデプロイするために、前のステップであるステージング環境への公開について理解しておいてください。