「カスタムコネクターの作成」へ移動

カスタムコネクターを作成するには、以下の手順を実行します。

1. 「 Microservices 」タブに移動します。

2. 画面右上の +新しく作成する をクリックします。
   
   

3. 「 Connection 」を選択し、 Pick & 作成をクリックします。
   

   

4. 左側のペインで カスタム コネクターカテゴリをクリックします。
   
   

5. 新しく作成する カスタム コネクターをクリックします。
   
   

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

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

   

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

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

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

• 一般 では、コネクター名、コネクターリンク名、説明、ロゴなど、カスタムコネクターの基本情報を定義します。

• Security では、Authentication種類、Authenticationパラメーター、Scopesなど、カスタムコネクターの認証設定を定義します。
  

1. 差出人の前の手順を続けて、コネクター名および説明をカスタムコネクター用に入力します。

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

  メモ:
-コネクター名に使用できる記号は* _ - @ / ! : | & ~ \ + のみです。 また、50文字以内である必要があります。
-コネクター名は、英字、数字、または_（アンダースコア）で開始してください。

• 説明（任意）は、カスタムコネクターの詳細やその他の情報を保存するテキストボックスです。

メモ:説明に使用できる記号は, . ( ) - _ * @ / \ ! : | ~ | & のみで、255文字以内である必要があります。  

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

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

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

1. コネクター名、コネクター リンク 名前、および説明は初期画面で自動入力されます。各項目をクリックすることで編集も可能です。

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

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

3. 「保存 & 続ける」をクリックすると、Securityセクションへ進みます。

  メモ :
  -コネクターの作成には、下書きとReadyの2つのステージがあります。コネクターのステージは画面右上に表示されます。
-最初は、ステージが下書きとして表示されます。下書きステージのコネクターでは外部連携を作成できません。
-すべての必須認証詳細を完了すると、設定 as Ready.をクリックしてReadyに設定できます。
-コネクターがReadyに設定されると、下書きステージに戻すことはできません。

セキュリティ - 認証詳細の指定

セキュリティセクションでは、要件に応じた認証の設定が可能です。対応している 認証タイプ とその詳細は、以下の表に記載されています。 アプリケーションに必要な認証種類を選択し、 保存 & 続ける をクリックしてください。

Authentication 種類	説明	項目
基本	対象サービスのAPIドキュメントに記載されているキーの指定が必要です。コネクター設定は、接続認証の段階で表示されます。 この際、パラメーター（ユーザー名、パスワード）の値を入力してください。入力された値は自動的にbase64アルゴリズムで暗号化され、ヘッダーとして「基本 <encrypted_value></encrypted_value>」形式で送信されます。	Parameter 名前：接続の認証時に表示される項目の表示名 メモ： Parameter 名前には、以下の特殊文字のみ使用できます * _ - @ / ! : | & ~ \ + Parameter 名前は、必ず英字または番号で開始してください。 Parameter キー： 対象サービスで指定されたAPIキー API ドキュメントに記載されている、パラメーター値を送信する先を指定します。このキーは、接続の認証時に記載された Parameter 名前 としてユーザーに表示されます。
APIキー	APIキーを利用してサードパーティのAPIと接続できます。APIキーは認証の際に固有の識別子として機能します。	Parameter 名前：パラメーターの表示名です。この名前は、接続を認証する際に表示されます。 メモ： Parameter 名前には、以下の特殊文字のみ使用できます * _ - @ / ! : | & ~ \ + Parameter 名前は、英字または数字で開始する必要があります。 Parameter キー: APIドキュメントで指定されたご希望のサービスのキーであり、そのパラメーター値を送信する必要があります。 メモ: パラメーター キーは差し込み項目値として扱われ、接続の認証時に指定したParameter名でユーザーに表示されます。 Parameter 場所: 認証の パラメーター がどのように送信されるかを決定します。指定されたURL（invoke URLスクリプト）と共に送信されます。対応するパラメータータイプは Query String、Form Data、およびHeaderです。
OAuth1	OAuth 1。+10、-10 プロトコルは、Creatorアプリケーションがユーザーの認証情報を開示せずに、APIを通じてサードパーティのリソースへアクセスできるようにします。ユーザーが認可を与えると、Creatorアプリケーションはサードパーティサービスから提供されるアクセストークンを使用して、ユーザーのリソースにアクセスできます。OAuth1は、ウェブベースのアプリケーションとの接続にのみ適しています。暗号署名と一時的なトークンを利用して通信を保護します。	Consumer キー：OAuth1におけるサードパーティアプリケーションの一意の識別子であり、サービスプロバイダーへのリクエスト時にアプリケーションを識別するために使用されます。アプリケーション側で厳重に管理してください。 メモ: Consumer キーには、英数字と以下の特殊文字 “ # $ % & ‘ ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ` ~ および半角スペースのみ使用できます。 Consumer キーには、日本語以外の言語は使用できません。 Consumer Secret: OAuth1においてconsumerキーに関連付けられるシークレットキーです。サードパーティアプリケーションがサービスプロバイダーへリクエストを送信する際に署名として使用されます。 メモ: Consumer シークレットには、英数字および次の特殊文字のみ使用できます: “ # $ % & ‘ ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ` ~（半角スペース1つを含む）。 Consumer シークレットには日本語以外の言語を含めることはできません。 Authorization URL: アプリケーションアクセスの認可を取得するため、希望するサービスのAPIドキュメントで指定されたURLです。 Token URL: 希望するサービスのAPIドキュメントで指定された、リクエストトークンと引き換えにアクセストークンを取得するためのURLです。 Request Token URL: 認可プロセスをアプリケーションとサードパーティサービス間で開始するために使用するリクエストトークンを取得するURLです。 取り消す Token URL: 指定したOAuth1アクセストークンまたは更新トークンを取り消すためのURLです。取り消しリクエストを行うと、指定したトークンに関連付けられているクライアント権限が削除されます。 メモ: URL は、プロトコル（http/https）、ホスト名（www。zylker。com) 、およびファイル名（index）を含むスタンダード形式で指定してください。 例：https://www。zylker。com/index OAuth1 は、ユーザーが認可を許可した後にコールバックを自動的に処理できます。これにより、認可サーバーはユーザーを Creator アプリケーションにリダイレクトし、アプリケーションが保護されたリソースへアクセスするために使用できる認可コードまたはアクセストークンを取得できます。
OAuth2	認証 - OAuth2 OAuth 2。+10、-10 は、Webサーバー上のユーザーデータへの限定的なアクセスを提供する認可プロトコルです。OAuth 2。+10、-10 サーバーは、Creator アプリケーションがリソース所有者の代わりに保護されたリソースへアクセスするために使用できるアクセストークンを発行します。OAuth2 にはスコープがあり、Creator アプリケーションがユーザーから特定の権限を要求することが可能です。また、Webアプリケーションと非Webベースのアプリケーションの両方に対応しています。	Grant 種類: 保護されたリソースへターゲットサーバーからアクセスする方法を指します。サポートされているgrant種類は以下の通りです。 Authorization コード Authorization コード With PKCE Client Credentials メモ:  すべてのgrant種類に対するAuthorizationパラメーターはヘッダーにて送信されます。 Authorization コード With PKCEをgrant種類として使用するコネクタの場合、Client シークレットパラメーターは入力する必要はありません。 クライアントID: サービスプロバイダーによって発行されたクライアントIDです。 メモ: クライアントIDは、英数字と次の記号のみ使用可能です: “ # $ % & ‘ ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ` ~ および半角スペース1つ。 クライアントIDには日本語以外の言語を含めることはできません。 Client シークレット: 認証用のクライアントシークレットです。 アプリケーション。 メモ: Client シークレット には、英数字および次の記号のみ使用できます: “ # $ % & ‘ ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ` ~ さらに半角スペース1文字も可能です。 Client シークレットには日本語以外の言語は使用できません。 クライアント認証: クライアントの認証情報（クライアントIDとClient シークレット）を、トークンリクエスト時に認可サーバーへ送信し、本人確認を行う方法を指定します。 フォームデータに含める(初期設定) リクエストの本文で、認証情報をフォームデータとして送信します。 認証ヘッダーに含める HTTP基本認証を用いて、リクエストのセキュリティヘッダーに認証情報を格納します。 メモ: クライアント認証は、さまざまなAPI認証要件との互換性を向上させ、設定ミスの可能性を減らします。 「いいえ」メソッドが明示的に選択済みの場合、認証情報はフォームデータ経由で送信されます。ただし、APIの要件に応じて、初期設定から送信方法を変更することが可能です。 Token URL: アクセストークンを取得するためのURL（APIドキュメントに記載されている該当サービスのもの）。 メモ: 以下に指定するRequest Token URLおよび取り消すToken URL項目は、「Grant種類」で「Authorizationコード」が選択済みの場合のみ適用されます。 取り消す Token URL: 指定したOAuth2アクセストークンまたは更新トークンを取り消すためのURL。トークンの取り消しリクエストを送信すると、指定トークンに紐付くクライアント権限が削除されます。 更新用トークンURL： 現在のaccess tokenが無効または有効期限切れとなった際に、新しいaccess tokenを取得するためのURLです。 メモ：URLは、プロトコル（http）、ホスト名（www。zylker。com）、 www。zylker。com）、 ファイル名（index）を含むスタンダード形式で指定してください。例： http://www。zylker。com/index。 詳細パラメーター Bearer 名前: APIリクエストの認証ヘッダーで接頭語として機能するテキストです。 期限日時: アクセストークンが失効する時間（秒単位）です。 初期設定の期限日時は3600秒です。 メモ: Bearer 名前は英数字のみ使用できます。 期限日時は数値のみ指定可能です。 期限日時は15分未満または24時間を超えて設定できません。
	OAuth Scopes（オプション） - アクセストークンを通じてユーザーに付与されるアクセス権限の範囲を制限します。	Scope 表示名: サードパーティの Scope の表示名です。 メモ: Scope 表示名には、次の特殊文字のみ使用できます: * _ - @ / ! : | & ~ \ + Scope 表示名は、必ず英字または番号で開始する必要があります。 追加できるスコープは最大50件までです。 Scope 値: サードパーティ サービスに対して要求するアクセス権限のレベルです。 Scope Delimiter: ご希望のサービス API でスコープを区切る際に使用するデリミタです。 メモ: 初期設定の Scope Delimiter はカンマです。
ベアラートークン	この認証種類は、セキュアなベアラートークンで認証し、サードパーティAPIへの接続を可能にします。	パラメーター場所: リクエスト内でパラメーターをどのように渡すかを指定します。この項目はデフォルトで『Header』に設定されています。 パラメーター名: パラメーターの表示名を設定します。この名前は接続の認証時に入力を求められます。デフォルトで『Bearer Token』と入力されており、カスタマイズ可能です。 メモ: パラメーター 名は次の特殊文字のみ使用可能です：* _ - @ / ! : | & ~ \ + • 英字または数字で始めてください。 パラメーターキー: 外部システムとの通信時に使用する技術的なキーを指定します。この項目は初期設定で『Authorization』に設定されており、編集できません。 トークン接頭語: トークンに付与される認証用の接頭語を定義します。リクエスト送信時、接頭語はトークンと共に含まれます。
AWS	この認証種類は、署名バージョン4認証を利用してAWSサービスへの接続を可能にします。	AWSサービス名: リクエストを送信する対象のAWSサービスを指定します。名前はAWS APIドキュメントに記載されている正確なサービス名と一致する必要があります。 AWS Region: リクエスト対象のサービスがホストされるAWSリージョンを指定します。リージョンはAWSがサポートする形式で入力してください（例: us-east-1, eu-west-2）。

設定方法は、カスタムコネクター作成時に選択した認証種類によって異なります。

1. 基本およびAPIキー認証
2. OAuth1認証
3. OAuth2認証
   
4. Bearerトークン
   
5. AWS

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

メモ: 以下の手順は、APIキーおよび基本認証の両方のタイプで共通です。異なるのは認証パラメーターの項目のみとなるため、ここではAPIキーを例として説明します。

1. Authentication 種類を選択したら、認証パラメーターを入力し、 保存 をクリックします。ここでは 開く Weather を例として表示しています。
   
   
   

2. また、下記の編集アイコンをクリックすることで Authentication 種類 を変更できます。
   
   
   
   
   メモ: Authentication 種類 は、コネクターが下書き段階にある場合のみ変更可能です。変更すると、すべてのコネクター設定が失われます。コネクターが「Ready」に設定された後は、Authentication 種類の変更はできません。

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

4. 認証情報の入力が完了したら、コネクターを「Ready」に設定します。
   
   ステージが下書き からReadyに変更されました。

5. Readyにマークされると、追加する Connectionボタンを使ってconnectionを追加できます。
   

メモ: OAuth2 ではスコープの設定は任意ですが、OAuth コネクターにスコープを追加することを強く推奨します。

1. OAuth2 で Authentication パラメーター の保存後、OAuth Scopesのセクションへ自動的に遷移します。または、左側のペインからOAuth Scopes をクリックしても移動できます。
   

2. 次のページで、 +追加する Scope をクリックします。
   

3. Scope 名前とScope 値を入力し、追加するをクリックします。ここでは、Dropboxのスコープを追加例としています。
   

4. 新しく追加するボタンをクリックして、さらにスコープを追加できます。
   

5. テーブル内の特定のスコープデータを編集または削除する場合は、三点リーダーをクリックします。
   

6. 複数のスコープを削除したい場合は、チェックボックスで選択し、削除をクリックします。下図を参照してください。
   

特定のscopeを検索するには、scope 名前またはscope 値を 検索する タブに入力してください。

8. 設定 as Ready ボタンをクリックします。ステージが 下書き から Ready に変更されます。
   
   
   

9. コネクターがReadyに設定された後、 追加する 外部連携 から連携を追加できます。
   

  メモ:
-カスタム コネクターで外部連携を追加した後は、scopesの編集や削除はできません。
-カスタム Connectorsを使用した外部連携は、Delugeのinvoke URL タスクで呼び出し、該当する操作APIを特定のシナリオやワークフローで指定してください。

Bearer Token認証の設定手順

Bearer Tokenを認証種類として選択すると、認証パラメーターを設定できる画面に移動します。

1. パラメーター場所は自動的にHeaderに設定され、編集できません。これにより、トークンがリクエストヘッダーで送信されることが決まります。
   
2. パラメーターキーはAuthorizationとして事前入力されており、変更できません。
   
3. パラメーター名前はBearer Tokenとして事前入力されています。必要に応じてカスタム名に編集できます。
   
4. 必要に応じてトークン接頭語（例：「Bearer」）を入力します。
   
5. 変更を行った後は、保存をクリックして認証設定を確定します。
   
6. コネクターをReadyに設定するには、ステージを下書きからReadyに変更します。これにより追加するConnectionボタンが有効になります。
   
7. 追加するConnectionをクリックして続行します。
   
8. コネクション名を入力し、適切なConnection Authorization Levelを選択します。
   
9. サードパーティサービスから取得したBearer Tokenを入力して認証を完了します。
   

メモ: コネクター作成時に設定したパラメーター名が、ここで項目名として表示されます。初期設定では「Bearer Token」です。

AWS認証の設定手順

『新しく作成するカスタムコネクター』へのナビゲーション方法  

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

• 追加する外部連携ページのBuilt-in Connectorsカテゴリーから   

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

1. Microservicesページに移動し、スクロールして外部連携セクションまで進みます。

2. 外部連携が3つ以下の場合は、管理 カスタム Connectorsをクリックします。外部連携セクションに表示されます。

3. i) 外部連携が3つを超える場合は、詳細表示をクリックしてください。アカウント内のすべての外部連携が一覧表示されます。

メモ: または、画面上部の外部連携タブから全外部連携のリストを表示することもできます。

ii) 管理 カスタム Connectorsをクリックします。

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

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

6. Creating your own カスタム コネクター セクションに記載の手順に従い、カスタム コネクターを作成します。

追加する 外部連携 ページの Built-in Connectors カテゴリーから

1. Microservices タブに移動し、右上の +新しく作成する をクリックします。
   
   
   

2. Connection を選択し、 Pick & 作成 をクリックします。
   

3. Built-in Connectors ページの一番下までスクロールし、 +作成 カスタム コネクター をクリックします。
   
   

メモ: 「検索する」タブを使用して、目的のコネクターを検索できます。ご希望のコネクターが組み込みコネクターリストに存在しない場合、+カスタムコネクターの作成リンクが表示されます。このリンクをクリックして、新しいカスタムコネクターを作成することもできます。

4. カスタムコネクターを作成セクションに記載されている手順に従って、独自のカスタムコネクターを作成してください。
   

関連トピック               

1. コネクターについて理解する
2. カスタムコネクターの管理
   
3. 外部連携について理解する
4. 外部連携の作成と認証