「カスタムコネクタの作成」

「カスタムコネクタの作成」

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

 注意: この機能は C6 でのみ使用可能です。
カスタムコネクター は、Zoho Creatorの 組み込みコネクター として利用できないサービスと統合するために作成されます。 所望のサービス用のコネクターを構成して接続を作成できます。 詳しくはこちら をご覧ください。

「カスタムコネクタの作成」に移動する

以下の操作を行って、カスタムコネクタを作成します。

  1. マイクロサービスのタブに移動してください。

  2. 右上の +新規作成 をクリックしてください。


  1. 選択 接続 して、クリックして 選択 & 作成してください。


  1. 左側のペインで、 CUSTOM CONNECTOR  カテゴリをクリックしてください。

  1. クリック 新規カスタムコネクターの作成。

  注: 他の方法をクリックするには こちら を参照してください。 カスタムコネクタを作成するには。

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

カスタムコネクターカードをクリックすることで接続も確立できます。 詳しくはこちら

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

カスタムコネクタを作成するには、以下の主要な構成が必要です。

  • 一般的な カスタムコネクタの基本情報を定義します,例えば コネクタ名, コネクタリンク名, 説明, および ロゴです。

  • セキュリティ は、認証タイプ認証パラメータスコープなど、カスタムコネクタの認証設定を定義します。

  1. 前の指示に続いて、カスタムコネクターの「コネクター名」と「説明」を入力します。

  • コネクタ名 は、作成したいコネクタの表示名です。

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

  • 説明 (任意)は、カスタムコネクターに関する詳細や追加情報を格納するテキストボックスです。

注:説明は、以下の特殊文字のみを使用できます、。()-_*@/\!:|~|&しかし、255文字を超えることはできません。 

  1. 「クリック」を押すと、カスタムコネクタビルダーの一般セクションに移動します。 「カスタムコネクタを作成」をクリックします。

一般 - 基本コネクターの詳細を更新する

「一般」セクションには、コネクタの基本的な詳細が含まれています。

  1. 名前、リンク名、および説明は最初のページから自動的に入力されます。各フィールドをクリックすることで、編集することもできます。

  注意:
-コネクタリンク名は、文字から始まる必要があり、50文字を超えてはなりません。
-コネクタリンク名には、_(アンダースコア)を除く特殊文字を含めてはいけません。  

  1. カスタムコネクター用のロゴをアップロードしてください。

  注意:

  - 画像サイズは1MB以下でなければなりません。
  - PNGJPG、およびJPEGの画像フォーマットのみがサポートされています。

3. クリック 保存して続行、そして セキュリティーセクションへと導かれます。



  注意 :
  -コネクタを作成するには2段階あります: 下書き 準備完了 。コネクタの具体的な段階は右上に表示されます。
  -最初は「下書き」としてマークされています。「下書き」段階ではコネクタを使った接続を作成できません。
  -必須の認証情報をすべて入力したら、「準備完了にマーク」をクリックして準備完了にできます。
  -コネクタを準備完了にしたら、「下書き」段階に戻すことはできません。

セキュリティ - 認証情報を指定する

セキュリティセクションを使用することで、必要に応じた認証を設定することができます。サポートされている 認証タイプ とその詳細は、以下の表に記載されています。 アプリケーションに必要な認証タイプを選択し、 保存して続行 をクリックしてください(図参照)。
 


認証タイプ 

説明

フィールド

基本

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


パラメーター名: 接続を認可する際に表示されるフィールドの名前 です。

注意:

  • パラメーター名には、次の特殊文字のみを使用できます * _ - @ / ! : | & ~ \ +

  • パラメーター名は、文字または数字から始める必要があります。

パラメーターキー: 対象のサービスで指定されたAPIキー  API  ドキュメントに対して、パラメーター値が送信される必要があります。このキーは、接続認証時にユーザーに提示されます。 パラメーター名 が指定されます。

APIキー


これにより、APIキーを使用して認証することで、サードパーティのAPIに接続できます。それは認証目的のための一意の識別子として機能します。


パラメータ名:接続を認可するときに表示されるパラメータの名前です。 この名前が表示されます。

注意:
  • パラメーター名には、次の特殊文字のみを使用できます * _ - @ / ! : | & ~ \ +

  • パラメーター名は、文字または数字で始まる必要があります。

パラメーターキー:必要なサービスのAPIドキュメンテーションで指定されたキーに対して、パラメーター値を送信する必要があります。

注: パラメーターキーはプレースホルダーの値であり、接続権限時に与えられたパラメーター名によってユーザーにプロンプトされます。 

パラメータの場所: 認証方法を決定します。 パラメーター 指定されたURLとともに送信されます。呼び出しURL スクリプト. サポートされるパラメータータイプは  クエリ文字列このヘルプガイドは、テクニカルなトピックについての詳細な情報を提供することを目的としています。このガイドは、テクニカルな問題の解決方法を提供し、お客様が最新の製品をより効率的に使用するために役立つ情報を提供します。フォームデータ, そしてヘッダー。

OAuth1OAuth1(オース1)
OAuth 1.0 プロトコルを使用すると、クリエイターアプリケーションはユーザーの資格情報を開示せずにAPIを介してサードパーティのリソースにアクセスできます。ユーザーが認可を与えると、クリエイターアプリケーションはサードパーティのサービスから提供されるアクセストークンを使用してユーザーのリソースにアクセスできます。 OAuth1はWebベースのアプリケーションとの接続にのみ効率的です。暗号署名と一時トークンを使用して接続を保護します。
コンシューマーキー:A OAuth1で外部アプリケーションを識別するための一意の識別子です。アプリケーションによって秘密に保たれるべきものです。

番号:
  1. コンシューマーキーには、英数字と以下の特殊文字「# $ % & ‘ ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ` ~」を含む半角スペースのみを使用できます。
  2. コンシューマーキーには、英語以外の言語を使用できません。
消費者秘密:OAuth1に関連付けられた消費者キーに関連付けられた秘密キーで、サービスプロバイダーに対する第三者アプリケーションが行うリクエストを署名するために使用されます。

注意:
  1. Consumer Secret は、英数字と以下の特殊文字「# $ % & ‘ ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ` ~」および半角スペースのみを使用できます。
  2. Consumer Secret には、英語以外の言語は使用できません。
認可URL必要なサービスのAPIドキュメントに記載されているURLを使用して、アプリケーションアクセスを認可します。

トークンURL:APIドキュメンテーションに記載されている所定のリクエストトークンと交換してアクセストークンを取得するURL。

リクエストトークンURL:アプリケーションとサードパーティーサービス間の認証プロセスを開始するために使用されるリクエストトークンを取得するためのURLです。

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

注意:
  1. URLは、プロトコル(http / https)、ホスト名( www.zylker.com) およびファイル名(index)を標準形式で持つ必要があります。
    例:                                    https://www.zylker.com/index
  2. OAuth1は、ユーザーが承認を与えた後に自動的にコールバックを処理する能力を持っています。 これにより、承認サーバーは、アプリケーションに承認コードまたはアクセストークンを持ってユーザーをクリエイターアプリケーションにリダイレクトできます。 これを使用して、保護されたリソースにアクセスできます。

OAuth2

OAuth2

OAuth2(オース・ツー)


認証-OAuth2
OAuth 2.0 は、Webサーバー上のユーザーデータへの限定的なアクセスを与える認可プロトコルです。OAuth 2.0サーバーは、クリエイターアプリケーションがリソースオーナーの代わりに保護されたリソースにアクセスするためのアクセストークンを発行します。 OAuth2には、クリエイターアプリケーションがユーザーから特定の許可を要求するスコープがあり、Webベースおよび非Webベースのアプリケーションの両方と互換性があります。


認可タイプ: 対象サーバから保護されたリソースへのアクセス方法を参照します。サポートされている認可タイプは認可コードおよびクライアント資格情報です。

注:両グラントタイプでヘッダーに承認パラメーターが送信されます。


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


注意:
  1. クライアントIDは、英数字と以下の特殊文字「# $ % & ‘ ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ` ~」(半角スペースを含む)のみ使用できます。
  2. クライアントIDには、英語以外の言語は使用できません。
クライアント秘密: 承認するためのクライアント秘密
アプリケーション。

注意:
  • クライアント秘密キーは、アルファベットと以下の特殊文字 “#$%&’()*+、ー。/:;<=>?@[\]^_{|}`~、半角スペースを含む文字のみ使用できます。

  • クライアント秘密キーには英語以外の言語を使用できません。

トークンURL:必要なサービスのAPIドキュメンテーションに記載された通り、アクセストークンを取得するためのURL。

注意:  以下のリクエストトークンURLおよびリボークトークンURLフィールドは、権限タイプが認可コードとして選択されている場合にのみ適用されます。


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


トークンを更新するURL: 現在のアクセストークンが無効または期限切れになった場合に新しいアクセストークンにアクセスするためのURLです。 

 

注意:URLは、プロトコル(http)、ホスト名( www.zylker.com)、およびファイル名(index)を含む標準形式である必要があります。 


高度なパラメータ


承認者名: APIリクエストの認証ヘッダーに先頭として使用されるテキスト です。


有効期限: アクセストークンの有効期限を示す秒数です。デフォルトの有効期限は3600秒です。

注意:

  • 持ち手の名前は英数字のみになります。

  • 有効期限は数字のみになります。

  • 有効期限は15分以下または24時間以上になりません。  


OAuth スコープ(任意) - これは、アクセストークンを介してユーザーに与えられるアクセスレベルを制限します。

 

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


注意:  

  • スコープ表示名には、以下の特殊文字のみ使用できます * _ - @ / ! : | & ~ \ +

  • スコープ表示名は、文字または数字から始める必要があります。

  • スコープの最大数は50個までです。

スコープ値: 第三者サービスを要求するアクセスレベルです。


スコープの区切り: 所望のサービスAPIがスコープを分割するために期待する区切り。

注意:
  • デフォルトのスコープ区切り文字はカンマです。

 

設定の部分は、カスタムコネクターを作成するために選択された認証タイプによって異なります 
  1. 基本認証およびAPIキー認証の設定手順
  2. OAuth1認証の設定手順
  3. OAuth2認証の設定手順

基本認証およびAPIキー認証の設定手順

注: 以下の手順は、APIキー基本認証の両方で同じです。 認証パラメーターフィールドのみが変わるため、APIキーを例として考えました。
  1. 一度認証タイプを選択し、認証パラメータを入力し、「保存」をクリックします。 例として、 Open Weather を示します。


  2. 設定を変更することもできます。 認証タイプ を、下図のように編集アイコンをクリックして変更してください。


    注: 認証タイプ は、コネクタがドラフトステージにあるときのみ変更できます。コネクタを準備完了にした場合は、認証タイプを変更することはできません。

  3. 認証情報を入力したら、コネクタを準備完了にしてください。


  4. 認証情報をすべて入力したら、コネクタをReadyにしてください。

    ステージが、DraftからReadyに変更されました。

  1. 「準備完了」とマークされたら、「接続の追加」ボタンを使用して接続を追加できます。

OAuth1 認証の設定手順

  1. 認証パラメータを、ターゲットサービスのAPIドキュメンテーションに記載されているとおり入力し、「保存」をクリックします。ここでは、Trelloを例として示します。


  2. コネクタを準備完了にし、「接続の追加」ボタンをクリックすることで接続を追加できます。

OAuth2 認証の設定手順

  1. 認証パラメーター アドバンスパラメーター を指定します。 ここでは、 Dropbox
    を例として示します。


    注意: リクエストトークンURLRevoke Token URL フィールドは、Grant TypeAuthorization Code として選択された場合にのみ表示されます。

  2. 高度なパラメータの場合、フィールドの値はデフォルトで ベアラー として、 ベアラー名 として 3600 として 有効期限を設定します。必要に応じてこれらの値を変更することができます。
    注意:
    - ベアラー名 は英数字のみになります。
    - 有効期限 は数字のみになります。
    - 有効期限 は15分以上24時間以下になります。 

  3. クリックして保存して続行をします。コネクタを接続に使用する準備ができたとしてマークします。オプションのスコープを追加することもできます。詳しくは次のセクションの手順を参照してください。
注:
- コネクターが準備完了になったら、 認証パラメータ を編集することはできません。
- 指定された認証パラメータは、接続認証時に要求されます。使用される認証タイプに応じて、 カスタムコネクターの接続認証の違い があります。

OAuthスコープを追加(OAuth2のみ適用 - 任意)
注意: OAuthコネクターにスコープを追加することを強くお勧めします。OAuth2のスコープはオプションですが。
  1. 保存後、 OAuth2 の認証パラメーター は、OAuth スコープのセクションにリダイレクトされます。また、左ペインから「OAuth スコープ」をクリックすることもできます。

  1. 次のページで、「+追加」をクリックしてください。

  1. 「スコープ名」と「スコープ値」を入力して、「追加」をクリックします。ここでは、Dropboxのスコープを追加するとします。

  1. 「新規追加」ボタンをクリックして、スコープを追加します。

  1. 三つの横線をクリックして、テーブル内の特定のスコープレコードを編集 または 削除 してください。

  1. 複数のスコープを削除したい場合は、チェックボックスをチェックして、以下のように「削除」をクリックしてください。

 

スコープ名またはスコープ値を入力することで、特定のスコープを検索することができます。 検索 タブをご利用ください。

  1. クリックしてください。 準備完了としてマーク ボタン。ステージは、 下書きから準備完了に変更されます。


  2. コネクターが「準備完了」としてマークされたら、 接続を追加 することができます。

  注意:
 -一旦、 カスタムコネクター との接続を追加した後は、スコープを編集または削除できません。
 - カスタムコネクター を使用した接続は、特定のシナリオ/ワークフローに関するアクションAPIを記述したDeluge invoke URLタスクを使用して呼び出す必要があります。

「新しいカスタムコネクターの作成」に移動する方法  

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

  1. マイクロサービスのページを開き、「カスタムコネクタの管理」をクリックしてください。

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

  1. カスタムコネクタがカードとして表示されている場合は、右上隅にある +新規作成 アイコンをクリックして、カスタムコネクタを作成します。


  1. 以下の手順に従って、独自のカスタムコネクタを構築するには、「カスタムコネクタの作成」 を参照してください。

「接続の追加ページ内のビルトインコネクターカテゴリーから」

  1. マイクロサービスタブを開き、右上の「+新規作成」をクリックしてください。


  1. 選択 接続 し、 Pick & Create をクリックしてください。

  2. ビルトインコネクタのページの最後までスクロールし、 +Create Custom Connector をクリックしてください。

注:検索タブを使用して接続を検索することができます。 組み込みコネクタリストに接続がない場合、 +Create Custom Connector リンクが表示されます。新しい Custom Connector を作成するために、このリンクをクリックすることもできます。

  1. 以下の手順に従って、独自のカスタムコネクタを構築するには、「カスタムコネクタの作成」 を参照してください。

関連トピック               

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

 

 

 

 

 

 







    Zoho CRM 管理者向けトレーニング

    「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。

    日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。

    Zoho CRM Training



              Zoho Desk Resources

              • Desk Community Learning Series


              • Digest


              • Functions


              • Meetups


              • Kbase


              • Resources


              • Glossary


              • Desk Marketplace


              • MVP Corner


              • Word of the Day









                                • Related Articles

                                • 理解コネクター

                                  お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 概要 コネクターを使用することで、Zoho Creatorアプリケーションがサードパーティーサービスと通信できます。特定のサービスに接続するために必要なプロパティを含み、複雑さを軽減し、安全な接続を確立します。 ...

                                Resources

                                Videos

                                Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                eBooks

                                Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                Webinars

                                Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                CRM Tips

                                Make the most of Zoho CRM with these useful tips.