カスタムコネクターを作成するには、次の操作を実行します。
[マイクロサービス]タブに移動します。
右上の[+新規作成]をクリックします。
[接続]を選択し、[選択して作成]をクリックします。
左ペインで[カスタムコネクター]カテゴリーをクリックします。
[新しいカスタムコネクターを作成]をクリックします。
メモ:カスタムコネクターを作成するその他の方法については、こちらをクリックしてください。
カスタムコネクターのカードをクリックして接続を作成することもできます。詳細はこちら
カスタムコネクターを作成するには、主に次の設定が必要です。
[全般]では、カスタムコネクターの基本情報を定義します。たとえば、[コネクター名]、[コネクターリンク名]、[説明]、および[ロゴ]などです。
[セキュリティ]では、カスタムコネクターの認証設定を定義します。たとえば、[認証の種類]、[認証パラメーター]、および[スコープ]などです。
前の手順に続いて、カスタムコネクターの[コネクター名]と[説明]を入力します。
[コネクター名]は、作成するコネクターの表示名です。
メモ: [説明](任意)は、カスタムコネクターの詳細や追加情報を保存するテキストボックスです。
メモ:説明に使用できる特殊文字は、, . ( ) - _ * @ / \ ! : | ~ | & のみです。また、255文字を超えることはできません。
[カスタムコネクターを作成]をクリックします。カスタムコネクタービルダーの[全般]セクションに移動します。
[全般]セクションには、コネクターの基本情報が含まれています。
最初のページから、[コネクター名]、[コネクターリンク名]、および[説明]が自動入力されます。各項目をクリックして編集することもできます。
メモ: カスタムコネクターのロゴをアップロードします。
メモ:
3. [保存して続行]をクリックすると、 セキュリティ セクションに移動します。
メモ:|
認証の種類 |
説明 |
項目 |
|
Basic認証 |
対象サービスのAPIドキュメントに記載されているキーを指定する必要があります。これらの コネクター設定は、接続の認可時に表示されます。ここで、パラメーター(ユーザー名とパスワード)の値を入力する必要があります。これらの値はbase64アルゴリズムで自動的に暗号化され、basic <encrypted_value>の形式でヘッダーとして渡されます。 |
[パラメーター名]:項目の表示名です。接続を認可するときに表示されます。
メモ:
[パラメーターキー]: パラメーター値の送信先として対象サービスの API ドキュメントで指定されているAPIキーです。このキーは、指定した [パラメーター名] とともに、接続の認可時にユーザーに表示されます。
|
|
APIキー |
APIキーで認証することで、サードパーティーAPIに接続できます。これは認証用の一意の識別子として機能します。
|
[パラメーター名]:パラメーターの表示名です。この名前は接続を認証する際に入力を求められます。
メモ:
[パラメーターキー]:パラメーター値を送信する際に使用するキー(対象サービスのAPIドキュメントで指定されたもの)です。
メモ:[パラメーターキー]はプレースホルダー値であり、接続の認証時に、指定されたパラメーター名でユーザーに入力が求められます。
[パラメーターの場所]:認証パラメーターを、invoke URLスクリプトで指定されたURLとともに送信する方法を決定します。サポートされているパラメーターの種類は、クエリー文字列、フォームデータ、およびヘッダーです。
|
| OAuth1 |
OAuth 1.0プロトコルにより、Creatorアプリケーションは、ユーザーの認証情報を開示することなく、APIを通じて第三者のリソースにアクセスできます。ユーザーが認可を許可すると、Creatorアプリケーションは第三者サービスから提供されるアクセストークンを使用して、ユーザーのリソースにアクセスできます。OAuth1は、Webベースのアプリケーションとの連携にのみ有効です。暗号署名と一時トークンを使用して接続を保護します。
|
コンシューマーキー:OAuth1における第三者アプリケーションの一意の識別子で、サービスプロバイダーへの要求でアプリケーションを識別するために使用されます。アプリケーション側で機密情報として保持する必要があります。
メモ:
コンシューマーシークレット:OAuth1でコンシューマーキーに関連付けられるシークレットキーで、第三者アプリケーションがサービスプロバイダーに送信する要求に署名するために使用されます。
メモ:
認可URL:アプリケーションアクセスの認可を取得するために、対象サービスのAPIドキュメントで指定されているURLです。
トークンURL:対象サービスのAPIドキュメントで指定されている、要求トークンと引き換えにアクセストークンを取得するためのURLです。
要求トークンURL:要求トークンを取得するためのURLです。アプリケーションと第三者サービス間の認可プロセスを開始するために使用されます。
トークン無効化URL:指定したOAuth1アクセストークンまたは更新トークンを無効化するためのURLです。トークン無効化要求により、指定したトークンに関連付けられているクライアント権限が削除されます。
メモ:
|
|
OAuth2 |
認証-OAuth2
OAuth 2.0は、Webサーバー上のユーザーデータへの限定的なアクセスを付与する認可プロトコルです。OAuth 2.0サーバーは、Creatorアプリケーションがリソース所有者に代わって保護されたリソースにアクセスするために使用できるアクセストークンを発行します。OAuth2はスコープで構成され、Creatorアプリケーションがユーザーに特定の権限を要求できるようにします。また、Webベースと非Webベースの両方のアプリケーションにより幅広く対応しています。
|
グラント種別:対象サーバーの保護されたリソースにアクセスする方法を指します。サポートされているグラント種別は次のとおりです。
メモ:
メモ:
クライアントシークレット:アプリケーションを認可するための
クライアントシークレットです。
メモ:
[クライアント認証]:トークン要求プロセス中に、クライアントの認証情報(クライアントIDとクライアントシークレット)を認可サーバーに送信し、クライアントの身元を証明する方法を指定します。
メモ:
[トークンURL]:対象サービスのAPIドキュメントに指定されている、アクセストークンを取得するためのURL。
メモ:以下で指定するリクエストトークンURLとトークン取り消しURLの項目は、グラント種別で認可コードが選択されている場合にのみ適用されます。
[トークン取り消しURL]:指定したOAuth2アクセストークンまたはリフレッシュトークンを取り消すためのURL。トークン取り消し要求により、指定したトークンに関連付けられたクライアント権限が削除されます。
[リフレッシュトークンURL]:現在のアクセストークンが無効になるか期限切れになった場合に、新しいアクセストークンを取得するためのURL。
メモ:URLは標準形式で指定する必要があります。プロトコル(http)、ホスト名( www.zylker.com), )とファイル名(index)を含めます。例: http://www.zylker.com/index。
[ベアラー名]:API要求の認証ヘッダーでプレフィックスとして機能するテキスト。
[有効期限]:アクセストークンの有効期限(秒)。デフォルトの有効期限は3,600秒です。
メモ:
|
|
[OAuthスコープ(任意)]- アクセストークンを通じてユーザーに付与されるアクセスレベルを制限します。
|
[スコープ表示名]:サードパーティスコープの表示名です。
メモ:
[スコープ値]:サードパーティサービスに対して要求するアクセスレベルです。
[スコープ区切り文字]:対象のサービスAPIでスコープの区切りとして想定される区切り文字です。
メモ:初期設定のスコープ区切り文字はコンマです。
|
|
ベアラートークン
|
この認証形式では、安全なベアラートークンで認証することで、サードパーティAPIに接続できます。
|
[パラメーターの場所]:要求内でパラメーターを渡す方法を指定します。この項目では「ヘッダー」が事前に選択されています。
[パラメーター名]:パラメーターの表示名を設定します。この名前は、接続を認証する際に表示されます。この項目には「ベアラートークン」が事前に入力されており、カスタマイズできます。
メモ:[パラメーター名]には次の条件があります。• 使用できる特殊文字は、* _ - @ / ! : | & ~ \ + のみです。 • 先頭には英字または数字のみ使用できます。
[パラメーターキー]:外部システムとの通信時に使用される技術的なキーを指定します。この項目の初期値は「Authorization」で、編集できません。
[トークンプレフィックス]:認証のためにトークンに付加するプレフィックスを定義します。要求の一部としてトークンを送信する際に、このプレフィックスが含まれます。
|
|
AWS
|
この認証形式では、署名バージョン4認証を使用してAWSサービスに接続できます。
|
[AWSサービス名]:要求の送信先となるAWSサービスを指定します。名前は、AWS APIドキュメントに記載されている正確なサービス名と一致している必要があります。
[AWSリージョン]:要求されたサービスをホストするAWSリージョンを定義します。リージョンは、AWSでサポートされている形式(例:us-east-1、eu-west-2)で指定する必要があります。
|
メモ:次の手順は、APIキーとBasic認証の両方の認証形式で同じです。認証パラメーター項目のみが変わるため、ここではAPIキーを例として使用します。
認証情報の入力が完了したら、コネクターを準備完了に設定します。
認証情報の入力が完了したら、コネクターを準備完了に設定します。
ステージが下書きから準備完了に変更されました。
準備完了に設定すると、 [接続を追加]ボタンを使用して接続を追加できるようになります。
メモ: OAuth2のスコープは任意ですが、OAuthコネクターにスコープを追加することを強くおすすめします。
次のページで、[+スコープを追加]をクリックします。
[スコープ名]と[スコープ値]を入力します。[追加]をクリックします。ここでは、Dropboxのスコープを追加する例を示します。
[新規追加]ボタンをクリックして、さらにスコープを追加します。
複数のスコープを一度に作成するには、[新規追加]の横にあるドロップダウンから[一括追加]を選択します。このオプションを選択すると、右側にペインが表示され、スコープ値を入力して[追加]を選択できます。
表内の特定のスコープデータを[編集]または[削除]するには、横方向の三点リーダーをクリックします。
複数のスコープを削除する場合は、チェックボックスを選択して対象を指定し、[削除]をクリックします(以下参照)。
特定のスコープは、スコープ名またはスコープ値を[検索]タブに入力して検索できます。
[準備完了にする]ボタンをクリックします。ステージが下書きから準備完了に変更されます。
Zohoサービスでは、OAuth 2.0認証標準が使用されます。Zoho Creatorで任意のZohoサービス向けにカスタムコネクターを設定するには、まずZohoのAPIコンソールでOAuthアプリケーションを登録し、Client IDとClient Secretを取得します。これらの認証情報により、Zoho Creatorはアクセス対象のAPIに必要なスコープでアクセストークンを要求できます。
カスタムコネクター向けにZoho OAuthを設定するには、以下の手順に従います。
メモ:ベースURLはDCによって異なる場合があります。
1. [マイクロサービス]ページに移動し、下にスクロールして[接続]セクションを表示します。
2. 接続が3件以下の場合は、[接続]セクション全体に表示される[カスタムコネクターの管理]をクリックします。
3. i) 接続が3件を超える場合は、[さらに表示]をクリックします。アカウント内のすべての接続の一覧が表示されます。
ii) [カスタムコネクターの管理]をクリックします。
4. [+カスタムコネクターを作成]をクリックします。
5. カスタムコネクターがカード形式で表示されている場合は、右上の[+新規作成]アイコンをクリックしてカスタムコネクターを作成します。
6. 独自のカスタムコネクターの作成 セクションの手順に従って、独自のカスタムコネクターを作成します。
[マイクロサービス]タブに移動し、右上の[+新規作成]をクリックします。
[接続]を選択し、[選択して作成]をクリックします。
組み込みコネクターのページの一番下までスクロールし、[+カスタムコネクターを作成]をクリックします。
メモ:[検索]タブを使用して、目的のコネクターを検索できます。コネクターが組み込みコネクターの一覧にない場合は、[+カスタムコネクターを作成]リンクが表示されます。このリンクをクリックして、新しいカスタムコネクターを作成することもできます。
独自のカスタムコネクターを構築するには、「独自のカスタムコネクターの作成」セクションに記載されている手順に従います。