接続の作成と認証

接続の作成と認証

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

Notesこのヘルプページは Developer Console バージョン 6 のユーザー向けです。旧バージョン（Developer Console 5）をお使いの場合は、こちらをクリックしてください。ご利用中の Developer Console のバージョンを確認する

1. このページの内容

Developer Console で Zoho およびサードパーティサービスとアプリケーションを連携するためのコネクションを作成し、認可する方法を説明します。操作を始める前に、コネクションについて詳しく確認できます。
Idea

2. 利用条件

コネクションの作成と管理は、スーパー管理者と開発者のみが行えます。Zoho Creator でこれらのアプリケーションにアクセスするクライアントは、インストール済みコネクションの認可と利用のみ行うことができます。

3. コネクションを作成する手順

Zoho Developer Console では、開発者がコネクションを設定してアプリケーションと外部クラウドサービスを連携させることができ、配布されたアプリ内でクライアントが利用できます。このプロセスは、必要な詳細情報を指定してコネクションを作成するステップと、アプリケーションを配布する前に開発またはステージ環境でテストするステップの 2 つで構成されます。Zoho Creator アカウントにコネクションを含むアプリケーションをインストールするクライアントは、利用前にそのコネクションを認可する必要があります。
Notes
メモ:
  1. Developer Console では、組み込みコネクタのみがサポートされています。
  2. Developer Console では、スーパー管理者または開発者が、開発またはステージ環境でテスト目的のためにコネクションを認可できます。Creator のインストール済みアプリのユーザーについては、選択したコネクションの種類に応じて、スーパー管理者、管理者、またはログインユーザーがコネクションを認可し、アプリケーション内で機能するようにする必要があります。
コネクションを作成して認可するには、次の手順に従います。
1. 左側ペインのMicroservicesセクションに移動し、+ Create New をクリックします。


2. 利用可能な組み込みコネクタから、必要なサービスコネクタを選択します。


Notes
メモ: 既存のコネクションを含むアプリケーションをインポートすると、1 対 1 の対応関係を維持するために、一意の名前とリンク名を持つ複製コネクションが作成されます。命名形式は次のとおりです：<old-connection-name>_copy。
3. コネクタを選択すると、ポップアップが表示されます。Connection Nameはコネクタを選択すると自動生成されますが、ボックスをクリックして編集できます。
同じコネクタを使用するコネクションが複数ある場合、命名形式は次のようになります。
<service-name> [space] Connection <sequence>。

4. 続いて表示されるポップアップで、認可レベルを選択します。コネクションにアクセスするクライアント向けの認可レベルは、次のいずれかを選択できます。
  1. Administrator: このオプションを選択した場合、アプリケーションをインストールしたスーパー管理者と開発者のみがコネクションを認可できます。一般ユーザーや管理権限のないロールはコネクションを認可できませんが、管理者による認可を通じてコネクションを利用できます。この場合、コネクションは管理者コネクションとなります。
  2. Logged-in User: このオプションを選択した場合、ロールに関係なく、アプリケーションをインストールした任意のログインユーザーがコネクションを認可できます。管理者コネクションとは異なり、これらのコネクションはログインユーザーごとに個別の認可を保持でき、実行ユーザーの認可に基づいて連携処理を行います。つまり、スーパー管理者、管理者、開発者、および任意のログインユーザーがコネクションを認可でき、このコネクションはログインユーザーコネクションとなります。ログインユーザーコネクションは、対応する一部の組み込みコネクタに対してのみ作成できます。
Notes
メモ: Developer Console では、認可レベルに関係なく、スーパー管理者と開発者は開発またはステージ環境でのテスト目的でコネクションを認可できます。
5. コネクションの認可方法を定義するために、Connection Modeを選択します。
    1. Quick connect (Zoho 管理の OAuth 資格情報) - 既定の Zoho 管理 OAuth 資格情報です。
    2. Custom（独自の OAuth 資格情報を使用） - 独自の資格情報を使用してコネクションを管理できます。

      • 登録済みのサードパーティ OAuth アプリから取得したClient Credential、ID、Client Secretを入力します。

        • 既存の資格情報があり、新しい資格情報を作成したい場合は、ドロップダウンからAdd Newを選択します。システム生成のClient Credentialが割り当てられます。
        • すでに複数のコネクションで同一コネクタにマッピングされている既存のOAuth資格情報を再利用する場合は、ドロップダウンのClient Credentialから 1 つ選択します。

Notesメモ: コネクション作成中に既存の資格情報を更新することはできません。Client Credential を更新するには、Connectionsの詳細ページに移動する必要があります。 資格情報の値が重複しないようにしてください。
Client ID に使用できる特殊文字は次のとおりです：* _ - @ / ! : | & ~ \ +。また、50 文字を超えることはできません。

      • Zoho Creator 用に表示されるCallback URL（リダイレクト URL）をコピーし、サードパーティ OAuth アプリを登録して Client ID と Client Secret を生成する際に必ず使用してください。
6. コネクションを作成する前に、[Advanced] ドロップダウンで必要なスコープを選択します。すべての利用可能なタブへのアクセスを許可する場合は [All Actions] を、特定の操作のみに制限する場合は [Only Specific Actions] を選択します。既定では [All Actions] が選択されています。
    Notes
    メモ: [Advanced] で、コネクション資格情報を使用して [All Actions] へのアクセスを有効にするオプションを選択した場合、そのコネクションに関連するすべての操作が既定で有効になり、選択解除はできません。
    カスタムの Client Credential を使用する場合は、Zoho Creator で選択した操作が、サードパーティサービス側で設定されている内容と一致していることを確認してください。OAuth 以外のタイプのコネクタが選択されている場合、資格情報を設定しなくても認可に進むことができます。
7. Create and Authorize をクリックします。
    1. デフォルトでは、［各環境で別の認証情報を使用する］にチェックを入れない限り、すべての環境で同じ認証情報が使用されます。初期設定では、認証情報はすべての環境で共通です。
Notes
メモ: 開発環境およびステージ環境の認証情報は、Developer Console 内の開発者にのみ適用されます。インストール済みの接続を利用するクライアントには、本番環境の認証情報のみが利用可能です。
8. ポップアップで認証情報を入力します。環境ごとに異なる認証情報を使用する場合は、該当する環境を選択します。
9. Authorize をクリックします。作成した接続の利用にあたり、認可が求められます。画面の指示に従って、OAuth やサードパーティの認可を完了してください。

接続が認可されると、アプリケーション内で使用できる状態になります。接続は Connection Details ページから編集できます。アプリをクライアント（マーケットプレイスまたはプライベート配布）に提供する前に、接続の変更内容を ステージ環境に公開する必要があります。

Notes
メモ: 必要な認証情報は、外部サービスが使用する認証方式（OAuth2、API キーなど）によって異なります。組み込みコネクタにはパラメーターがあらかじめ設定されているため、必要な認証情報を入力するだけで利用できます。
接続への変更は、その接続が参照されているアプリケーション内のコンポーネントと一緒にのみ、ステージ環境へ公開できます。

3.1 認証方式の違い

  1. OAuth2 認証: Zoho CRM や Salesforce などのサービスは OAuth2 認証を使用します。Authorize をクリックすると、そのサービスの認可ページにリダイレクトされ、要求されている権限を承認します。
  2. Basic 認証: Zoho Projects などのサービスでは、ユーザー名とパスワード（認証トークン）が必要です。接続の作成時にこれらのパラメーターを設定し、認可時にユーザーが認証情報を入力します。
  3. API キー認証: Twilio などのサービスでは、接続の設定時に API キーを入力します。

4. 注意点

  1. Developer Console では、必要な詳細を指定して接続を作成し、テスト用にスーパー管理者または開発者が認可します。
  2. 接続は、それが参照されているコンポーネントと一緒にのみ、ステージ環境へ公開できます。
  3. クライアントは、アプリケーションを自分の Zoho Creator アカウントにインストールする際に、接続を認可する必要があります。
次のステップ
前のステップ
次のステップ
接続の作成と認可について理解したら、次はこれらの接続をどのように管理するか を確認しましょう。
前のステップ
このページに進む前に、接続と、コネクタについて理解しておいてください。