カスタムコネクタの作成

カスタムコネクタの作成

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

メモ:この機能はC6でのみ利用できます。
カスタムコネクターは、Zoho Creatorの組み込みコネクターとして提供されていないサービスと連携するために作成します。目的のサービス用に独自のコネクターを設定し、接続を作成できます。コネクターの詳細はこちら
メモ既存のPayPal、PayflowPro、Payments Proのバージョンは2024年9月26日に廃止され、この日以降、支払い取引は処理されません。支払い処理を中断なく継続するには、最新バージョンに移行してください詳細はこちら

[カスタムコネクターを作成]への移動

カスタムコネクターを作成するには、次の操作を実行します。

  1. [マイクロサービス]タブに移動します。

  2. 右上の[+新規作成]をクリックします。

  1. [接続]を選択し、[選択して作成]をクリックします。

  1. 左ペインで[カスタムコネクター]カテゴリーをクリックします。

  1. [新しいカスタムコネクターを作成]をクリックします。

Notesメモ:カスタムコネクターを作成するその他の方法については、こちらをクリックしてください

  1. 以前にカスタムコネクターを作成している場合、カスタムコネクターのページにカードとして表示されます。右上の[+新規作成]アイコンをクリックすると、ビルダーが表示されます。次に、次のセクションの手順に従って、独自のカスタムコネクターを作成します。

カスタムコネクターのカードをクリックして接続を作成することもできます。詳細はこちら

カスタムコネクターの作成

カスタムコネクターを作成するには、主に次の設定が必要です。

    • [全般]では、カスタムコネクターの基本情報を定義します。たとえば、[コネクター名][コネクターリンク名][説明]、および[ロゴ]などです。

    • [セキュリティ]では、カスタムコネクターの認証設定を定義します。たとえば、[認証の種類][認証パラメーター]、および[スコープ]などです。

    1. 前の手順に続いて、カスタムコネクターの[コネクター名][説明]を入力します。

    • [コネクター名]は、作成するコネクターの表示名です。

    Notes   メモ:
    ・コネクター名に使用できる特殊文字は、* _ - @ / ! : | & ~ \ + のみです。 また、 50文字を超えることはできません。
    ・コネクター名は、英字、数字、または _(アンダースコア)で始める必要があります。

    • [説明](任意)は、カスタムコネクターの詳細や追加情報を保存するテキストボックスです。

    Notes メモ:説明に使用できる特殊文字は、, . ( ) - _ * @ / \ ! : | ~ | & のみです。また、255文字を超えることはできません。  

    1. [カスタムコネクターを作成]をクリックします。カスタムコネクタービルダーの[全般]セクションに移動します。

    [全般] - コネクターの基本情報の更新

    [全般]セクションには、コネクターの基本情報が含まれています。

    1. 最初のページから、[コネクター名]、[コネクターリンク名]、および[説明]が自動入力されます。各項目をクリックして編集することもできます。


    Notes   メモ:
    -コネクターリンク名は英字で始める必要があり、50文字を超えることはできません。
    -コネクターリンク名には、_(アンダースコア)以外の特殊文字を含めることはできません。  

    1. カスタムコネクターのロゴをアップロードします。

      メモ:

      -画像サイズは1MB未満である必要があります。
    -対応している画像形式は、PNG、JPGJPEGのみです。

    3. [保存して続行]をクリックすると、 セキュリティ セクションに移動します。



    Notes   メモ:
      -コネクターの作成には、下書き準備完了の2つの段階があります。コネクターの段階は右上に表示されます。
    -初期状態では、段階は下書きと表示されます。下書き段階のコネクターでは接続を作成できません。
    -必須の認証情報をすべて入力すると、[準備完了にする]をクリックして準備完了にできます。
    -コネクターを準備完了にすると、下書き段階に戻すことはできません。


    セキュリティ - 認証情報の指定

    セキュリティセクションでは、要件に応じて認証を設定できます。対応している 認証の種類 とその詳細は、以下の表に記載されています。 アプリケーションに必要な認証の種類を選択し、 [保存して続行] を図のようにクリックします。


    認証の種類

    説明

    項目

    Basic認証

    対象サービスのAPIドキュメントに記載されているキーを指定する必要があります。これらの コネクター設定は、接続の認可時に表示されます。ここで、パラメーター(ユーザー名とパスワード)の値を入力する必要があります。これらの値はbase64アルゴリズムで自動的に暗号化され、basic <encrypted_value>の形式でヘッダーとして渡されます。


    [パラメーター名]:項目の表示名です。接続を認可するときに表示されます。
    Notes
    メモ:
    • [パラメーター名]に使用できる特殊文字は、次の文字のみです: * _ - @ / ! : | & ~ \ +

    • [パラメーター名]は英字または数字で始める必要があります。

    [パラメーターキー]: パラメーター値の送信先として対象サービスの API ドキュメントで指定されているAPIキーです。このキーは、指定した [パラメーター名] とともに、接続の認可時にユーザーに表示されます。

    APIキー


    APIキーで認証することで、サードパーティーAPIに接続できます。これは認証用の一意の識別子として機能します。



    [パラメーター名]:パラメーターの表示名です。この名前は接続を認証する際に入力を求められます。
    Notes
    メモ:
    • [パラメーター名]に使用できる特殊文字は次のもののみです。* _ - @ / ! : | & ~ \ +

    • [パラメーター名]の先頭に使用できるのは文字または数字のみです。

    [パラメーターキー]:パラメーター値を送信する際に使用するキー(対象サービスのAPIドキュメントで指定されたもの)です。

    Notesメモ:[パラメーターキー]はプレースホルダー値であり、接続の認証時に、指定されたパラメーター名でユーザーに入力が求められます。


    [パラメーターの場所]:認証パラメーターを、invoke URLスクリプトで指定されたURLとともに送信する方法を決定します。サポートされているパラメーターの種類は、クエリー文字列フォームデータ、およびヘッダーです。

    OAuth1
    OAuth 1.0プロトコルにより、Creatorアプリケーションは、ユーザーの認証情報を開示することなく、APIを通じて第三者のリソースにアクセスできます。ユーザーが認可を許可すると、Creatorアプリケーションは第三者サービスから提供されるアクセストークンを使用して、ユーザーのリソースにアクセスできます。OAuth1は、Webベースのアプリケーションとの連携にのみ有効です。暗号署名と一時トークンを使用して接続を保護します。
    コンシューマーキーOAuth1における第三者アプリケーションの一意の識別子で、サービスプロバイダーへの要求でアプリケーションを識別するために使用されます。アプリケーション側で機密情報として保持する必要があります。
    Notes
    メモ:
    1. コンシューマーキーには、英数字と次の特殊文字(単一の空白文字を含む)のみ使用できます:' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ` ~
    2. コンシューマーキーには、英語以外の言語は使用できません。
    コンシューマーシークレット:OAuth1でコンシューマーキーに関連付けられるシークレットキーで、第三者アプリケーションがサービスプロバイダーに送信する要求に署名するために使用されます。
    Notes
    メモ:
    1. コンシューマーシークレットには、英数字と次の特殊文字(単一の空白文字を含む)のみ使用できます:' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ` ~
    2. コンシューマーシークレットには、英語以外の言語は使用できません。
    認可URL:アプリケーションアクセスの認可を取得するために、対象サービスのAPIドキュメントで指定されているURLです。

    トークンURL:対象サービスのAPIドキュメントで指定されている、要求トークンと引き換えにアクセストークンを取得するためのURLです。

    要求トークンURL:要求トークンを取得するためのURLです。アプリケーションと第三者サービス間の認可プロセスを開始するために使用されます。

    トークン無効化URL:指定したOAuth1アクセストークンまたは更新トークンを無効化するためのURLです。トークン無効化要求により、指定したトークンに関連付けられているクライアント権限が削除されます。
    Notes
    メモ:
    1. URLは、プロトコル(http/https),、ホスト名( www.zylker.com) )とファイル名(index)を含む標準形式にする必要があります。
      例:
      https://www.zylker.com/index
    2. OAuth1では、ユーザーが認可を許可した後のコールバックを自動的に処理できます。これにより、認可サーバーはユーザーをCreatorアプリケーションにリダイレクトし、アプリケーションが保護されたリソースにアクセスするために使用できる認可コードまたはアクセストークンを渡せます。

    OAuth2



    認証-OAuth2
    OAuth 2.0は、Webサーバー上のユーザーデータへの限定的なアクセスを付与する認可プロトコルです。OAuth 2.0サーバーは、Creatorアプリケーションがリソース所有者に代わって保護されたリソースにアクセスするために使用できるアクセストークンを発行します。OAuth2はスコープで構成され、Creatorアプリケーションがユーザーに特定の権限を要求できるようにします。また、Webベースと非Webベースの両方のアプリケーションにより幅広く対応しています。



    グラント種別:対象サーバーの保護されたリソースにアクセスする方法を指します。サポートされているグラント種別は次のとおりです。
    1. 認可コード
    2. PKCE付き認可コード
    3. クライアント認証情報
    Notes
    メモ:
    1. すべてのグラント種別の認可パラメーターは、ヘッダーで送信されます。
    2. PKCE付き認可コードをグラント種別として使用するコネクターでは、クライアントシークレットパラメーターは不要です。


    クライアントID:サービスプロバイダーによって発行されるクライアントIDです。

    Notes
    メモ:
    1. クライアントIDには、英数字と次の特殊文字(単一の空白文字を含む)のみ使用できます:' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ` ~
    2. クライアントIDには、英語以外の言語は使用できません。
    クライアントシークレット:アプリケーションを認可するための
    クライアントシークレットです。
    Notes
    メモ:
    • クライアントシークレットには、英数字と次の特殊文字(単一の空白文字を含む)のみ使用できます:' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ` ~

    • クライアントシークレットには、英語以外の言語は使用できません。

    [クライアント認証]:トークン要求プロセス中に、クライアントの認証情報(クライアントIDとクライアントシークレット)を認可サーバーに送信し、クライアントの身元を証明する方法を指定します。

    • [フォームデータに含める](デフォルト)

      • 要求本文で送信されるフォームデータに認証情報を追加します。

    • [認可ヘッダーに含める]

      • HTTP Basic認証を使用して、要求のセキュリティヘッダーに認証情報を配置します。

    Notesメモ
    • クライアント認証により、APIごとに異なる認証要件との互換性が向上し、設定ミスを減らせます。

    • 方法が明示的に選択されていない場合、デフォルトではフォームデータ経由で認証情報が送信されます。ただし、APIの要件に応じて、デフォルトの方法から変更できます。


    [トークンURL]:対象サービスのAPIドキュメントに指定されている、アクセストークンを取得するためのURL。

    Notesメモ:以下で指定するリクエストトークンURLとトークン取り消しURLの項目は、グラント種別で認可コードが選択されている場合にのみ適用されます。

    [トークン取り消しURL]:指定したOAuth2アクセストークンまたはリフレッシュトークンを取り消すためのURL。トークン取り消し要求により、指定したトークンに関連付けられたクライアント権限が削除されます。



    [リフレッシュトークンURL]:現在のアクセストークンが無効になるか期限切れになった場合に、新しいアクセストークンを取得するためのURL。
    Notesメモ:URLは標準形式で指定する必要があります。プロトコル(http)、ホスト名( www.zylker.com), )とファイル名(index)を含めます。例: http://www.zylker.com/index


    詳細パラメーター




    [ベアラー名]:API要求の認証ヘッダーでプレフィックスとして機能するテキスト



    [有効期限]:アクセストークンの有効期限(秒)。デフォルトの有効期限は3,600秒です。
    Notes
    メモ:
    • [ベアラー名]には英数字のみを使用できます。

    • [有効期限]には数値のみを使用できます。

    • [有効期限]は15分未満または24時間超には設定できません。


    [OAuthスコープ(任意)]- アクセストークンを通じてユーザーに付与されるアクセスレベルを制限します。

     

    [スコープ表示名]:サードパーティスコープの表示名です。

    Notes
    メモ:
    1. [スコープ表示名]に使用できる特殊文字は、* _ - @ / ! : | & ~ \ + のみです。
    2. [スコープ表示名]の先頭には、英字または数字のみ使用できます。
    3. 追加できるスコープは最大50件です。
    [スコープ値]:サードパーティサービスに対して要求するアクセスレベルです。


    [スコープ区切り文字]:対象のサービスAPIでスコープの区切りとして想定される区切り文字です。

    Notesメモ:初期設定のスコープ区切り文字はコンマです。

    ベアラートークン

    この認証形式では、安全なベアラートークンで認証することで、サードパーティAPIに接続できます。

    [パラメーターの場所]:要求内でパラメーターを渡す方法を指定します。この項目では「ヘッダー」が事前に選択されています。

    [パラメーター名]:パラメーターの表示名を設定します。この名前は、接続を認証する際に表示されます。この項目には「ベアラートークン」が事前に入力されており、カスタマイズできます。
    Notesメモ:[パラメーター名]には次の条件があります。
    • 使用できる特殊文字は、* _ - @ / ! : | & ~ \ + のみです。

    • 先頭には英字または数字のみ使用できます。

    [パラメーターキー]:外部システムとの通信時に使用される技術的なキーを指定します。この項目の初期値は「Authorization」で、編集できません。

    [トークンプレフィックス]:認証のためにトークンに付加するプレフィックスを定義します。要求の一部としてトークンを送信する際に、このプレフィックスが含まれます。
    AWS
    この認証形式では、署名バージョン4認証を使用してAWSサービスに接続できます。
    [AWSサービス名]:要求の送信先となるAWSサービスを指定します。名前は、AWS APIドキュメントに記載されている正確なサービス名と一致している必要があります。

    [AWSリージョン]:要求されたサービスをホストするAWSリージョンを定義します。リージョンは、AWSでサポートされている形式(例:us-east-1、eu-west-2)で指定する必要があります。

     

    カスタムコネクターの作成時に選択した認証形式によって、設定内容は異なります。
    1. Basic認証とAPIキー認証
    2. OAuth1認証
    3. OAuth2認証
    4. ベアラートークン
    5. AWS

    Basic認証とAPIキー認証の設定手順

    Notes メモ:次の手順は、APIキーBasic認証の両方の認証形式で同じです。認証パラメーター項目のみが変わるため、ここではAPIキーを例として使用します。
    1. [認証形式]を選択したら、認証パラメーターを入力し、[保存]をクリックします。こちらでは、 Open Weather を例として示しています。


    2. 以下のように、編集アイコンをクリックして[認証形式]を変更することもできます。


      メモ: [認証形式]は、コネクターが下書き段階の場合にのみ変更できます。変更すると、すべてのコネクター設定が失われます。コネクターを準備完了にすると、認証形式は変更できません。

    3. 認証情報の入力が完了したら、コネクターを準備完了に設定します。


    4. 認証情報の入力が完了したら、コネクターを準備完了に設定します。

      ステージが下書きから準備完了に変更されました。

    1. 準備完了に設定すると、 [接続を追加]ボタンを使用して接続を追加できるようになります。

    OAuth1認証の設定手順

    1. 対象サービスのAPIドキュメントに記載されている[認証パラメーター]を入力し、[保存]をクリックします。こちらでは、例としてTrelloを示しています。


    2. コネクターを準備完了として設定すると、[接続を追加]ボタンをクリックして接続を追加できるようになります。

    OAuth2認証の設定手順

    1. [認証パラメーター][詳細パラメーター]を図のように指定します。こちらでは、例として Dropbox
      を示しています。


      メモ:[リクエストトークンURL]と[トークン取り消しURL]の項目は、[付与タイプ][認可コード]が選択されている場合にのみ表示されます。

    2. [詳細パラメーター]では、項目の既定値として Bearer([Bearer名])と3,600[有効期間])が設定されています。必要に応じて、これらの値を変更できます。
      メモ:
      -[Bearer名]には、英数字のみを使用できます。
      -[有効期間]には、数値のみを入力できます。
      -[有効期間]は15分未満または24時間超には設定できません。

    3. [保存して続ける]をクリックします。接続で使用できるように、コネクターを準備完了として設定します。準備完了として設定する前に、任意のスコープを追加することもできます。詳細については、次のセクションの手順を参照してください。
    メモ:
    - 指定した認証パラメーターは、接続の認可時に入力を求められます。使用する認証タイプに応じて、 カスタムコネクターの接続認可には違いがあります

    OAuthスコープの追加(OAuth2のみ対象 - 任意)
    Notes メモ: OAuth2のスコープは任意ですが、OAuthコネクターにスコープを追加することを強くおすすめします。
    1. OAuth2で認証パラメーターを保存すると[OAuthスコープ]セクションに移動します。また、左ペインの[OAuthスコープ]をクリックして移動することもできます。
    2. 次のページで、[+スコープを追加]をクリックします。

    3. [スコープ名][スコープ値]を入力します。[追加]をクリックします。ここでは、Dropboxのスコープを追加する例を示します。

    4. [新規追加]ボタンをクリックして、さらにスコープを追加します。

    5. 複数のスコープを一度に作成するには、[新規追加]の横にあるドロップダウンから[一括追加]を選択します。このオプションを選択すると、右側にペインが表示され、スコープ値を入力して[追加]を選択できます。

    6. 表内の特定のスコープデータを[編集]または[削除]するには、横方向の三点リーダーをクリックします。

    7. 複数のスコープを削除する場合は、チェックボックスを選択して対象を指定し、[削除]をクリックします(以下参照)。
       

    8. 特定のスコープは、スコープ名またはスコープ値を[検索]タブに入力して検索できます。 

    9. [準備完了にする]ボタンをクリックします。ステージが下書きから準備完了に変更されます。

    10. コネクターが準備完了としてマークされると、[接続を追加]を使用して接続を追加できます。


      メモ:
    1. 入力した各値は、スコープ名とスコープ値の両方として使用されます。
    2. スコープ名は、コンマ区切りの値として入力するか、Enterキーを押して各スコープを追加できます
    3. 各カスタムコネクターには、個別または一括で最大50件のスコープを追加できます。追加時に、スコープ数と重複スコープの有無が検証されます。
    4. スコープは個別のエントリーとして作成されます。初期設定のスコープ名は、コネクターを準備完了としてマークする前であれば後から変更できます。
    5. スコープは、 カスタムコネクターで接続を追加した後は、編集または削除できません。
    6. カスタムコネクターを使用する接続は、Delugeのinvoke URLタスクを使用して呼び出す必要があります。その際、特定のシナリオに対応するアクションAPIを指定します/workflow.

    Bearer Token認証の設定手順

    認証方式として[Bearer Token]を選択すると、認証パラメーターを設定できる画面に移動します。
    1. [パラメーターの場所]は自動的に[ヘッダー]に設定され、編集できません。これにより、トークンがリクエストヘッダーで渡されることが決まります。
    2. [パラメーターキー]にはAuthorizationがあらかじめ入力されており、変更できません。
    3. [パラメーター名]にはBearer Tokenがあらかじめ入力されています。必要に応じて任意の名前に変更できます。
    4. 必要に応じて、[トークンの接頭辞](例:「Bearer」)を入力します。
    5. 変更後、[保存]をクリックして認証設定を確定します。
    6. コネクターを準備完了としてマークし、ステージを下書きから準備完了に変更します。これにより、[接続を追加]ボタンが有効になります。
    7. [接続を追加]をクリックして進みます。
    8. [接続の名前]を入力し、適切な[接続の認証レベル]を選択します。
    9. サードパーティサービスから取得したBearer Tokenを入力して、認証を完了します。
    メモ:コネクター作成時に設定したパラメーター名が、こちらの項目名として表示されます。デフォルトでは「Bearer Token」です。

    AWS認証の設定手順

    認証の種類としてAWSを選択すると、認証パラメーターの設定を求められます。
    1. [AWSサービス名][AWSリージョン]の値を入力します。
    2. [保存]をクリックして、これらの認証設定を適用します。
    3. コネクターを準備完了として設定し、ステージを下書きから準備完了に変更します。これにより、[接続を追加]ボタンが有効になります。
    4. 続行するには、[接続を追加]をクリックします。
    5. 認証を完了するには、AWSサービスから取得した[AWSアクセスキー][AWSシークレットキー]を入力します。
    メモ:続行する前に、AWSアカウントの認証情報が正しいことを確認してください。

    カスタムコネクター向けZoho OAuthの設定

    Zohoサービスでは、OAuth 2.0認証標準が使用されます。Zoho Creatorで任意のZohoサービス向けにカスタムコネクターを設定するには、まずZohoのAPIコンソールでOAuthアプリケーションを登録し、Client IDとClient Secretを取得します。これらの認証情報により、Zoho Creatorはアクセス対象のAPIに必要なスコープでアクセストークンを要求できます。

    カスタムコネクター向けにZoho OAuthを設定するには、以下の手順に従います。

    Zoho OAuthクライアントの登録

    1. https://api-console.zoho.comに移動し、Zohoアカウントでサインインします
    2. [クライアントを追加]を選択し、クライアントの種類として[サーバーベースのアプリケーション]を選択します。
    3. 参照用の[クライアント名]と[ホームページURL]を入力します。
      [クライアント名]:アプリケーションを識別するための名前です。
      [ホームページURL]:参照または識別用の任意の有効なURLです。
    4. 以下のリンクを使用して[承認済みリダイレクトURL]を入力します:https://creator.zoho.com/integration/oauth/callback
    NotesメモベースURLはDCによって異なる場合があります。
    1. [作成]をクリックします。
    2. 作成後、クライアントの詳細ページから生成された[Client ID][Client Secret]をコピーします。これらの値はZoho Creatorで必要になります。

    OAuth2カスタムコネクターの設定

    1. Zoho Creator[カスタムコネクターの作成]ページに移動します。
    2. [認証の種類][OAuth2認証]に設定します
    3. 以下の認可パラメーターを入力します。
      1. [権限付与の種類](事前入力済み、変更不要)-[認可コード]
      2. [クライアント認証](事前入力済み、変更不要)-[フォームデータに含める]。
      3. 手順1で取得した[Client ID][Client Secret]を入力します
      4. [認可URL]:https://accounts.zoho.com/oauth/v2/auth?access_type=offline&prompt=consent
      5. [トークンURL]および[更新トークンURL]:https://accounts.zoho.com/oauth/v2/token
      6. [トークン取り消しURL]:https://accounts.zoho.com/oauth/v2/token/revoke
      7. Zoho APIの要件に応じて[スコープ]を入力します。
    4. [保存して続行]をクリックします。コネクターを準備完了として設定し、このOAuth設定を使用して対象のZohoサービス用の接続の作成に進みます。

    [新しいカスタムコネクターを作成]に移動する各種方法  

    [カスタムコネクターの管理]ページから

    1. [マイクロサービス]ページに移動し、下にスクロールして[接続]セクションを表示します。


    2. 接続が3件以下の場合は、[接続]セクション全体に表示される[カスタムコネクターの管理]をクリックします。


    3. i) 接続が3件を超える場合は、[さらに表示]をクリックします。アカウント内のすべての接続の一覧が表示されます。

    メモ:または、上部の[接続]タブに移動して、接続の一覧全体を表示することもできます。

     

    ii) [カスタムコネクターの管理]をクリックします。


       

    4. [+カスタムコネクターを作成]をクリックします。


    5. カスタムコネクターがカード形式で表示されている場合は、右上の[+新規作成]アイコンをクリックしてカスタムコネクターを作成します。


    6. 独自のカスタムコネクターの作成 セクションの手順に従って、独自のカスタムコネクターを作成します。

    [接続の追加]ページの組み込みコネクターカテゴリーから

    1. [マイクロサービス]タブに移動し、右上の[+新規作成]をクリックします。


    1. [接続]を選択し、[選択して作成]をクリックします。

    2. 組み込みコネクターのページの一番下までスクロールし、[+カスタムコネクターを作成]をクリックします。

    Notes メモ:[検索]タブを使用して、目的のコネクターを検索できます。コネクターが組み込みコネクターの一覧にない場合は、[+カスタムコネクターを作成]リンクが表示されます。このリンクをクリックして、新しいカスタムコネクターを作成することもできます。

    1. 独自のカスタムコネクターを構築するには、「独自のカスタムコネクターの作成」セクションに記載されている手順に従います。

    関連トピック               

    1. コネクターの概要
    2. カスタムコネクターの管理
    3. 接続の概要
    4. 接続の作成と認証