［カスタムコネクターを作成］への移動

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

1. ［ Microservices ］タブに移動します。

2. 画面右上の ［+ 新規作成］ をクリックします。
   
   

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

   

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

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

メモ: こちらをクリックすると、 カスタムコネクターを作成する別の方法を確認できます。

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

   

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

カスタムコネクターを作成する

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

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

• Security では、カスタムコネクターの認証設定（認証タイプ、認証パラメーター、スコープ など）を定義します。
  

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

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

  メモ:
・コネクター名に使用できる記号は、次のもののみです：* _ - @ / ! : | & ~ \ + また、50 文字を超えることはできません。
・コネクター名は、英字、数字、または _（アンダースコア）のいずれかで開始する必要があります。

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

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

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

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

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

1. コネクター名、コネクターリンク名、説明は、最初のページで入力した内容が自動入力されます。各項目をクリックして編集することもできます。

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

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

3. [保存 & 続ける] をクリックすると、 Security セクションに移動します。

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

Security - 認証詳細の指定

Security セクションでは、要件に基づいて認証方式を設定できます。サポートされている Authentication Types（認証タイプ） とその詳細は、以下の表にまとめられています。 アプリケーションに必要な認証タイプを選択し、表示されているように 保存 & 続ける をクリックします。

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

設定内容は、カスタムコネクターを作成する際に選択した認証タイプによって異なります。

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

基本認証および API キー認証を設定する手順

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

1. 認証タイプを選択したら、認証パラメーターを入力し、 保存 をクリックします。ここでは例として、 Open Weather を使用しています。
   
   
   

2. 編集アイコンをクリックすることで、 認証タイプ を変更することもできます（下図参照）。
   
   
   
   
   メモ: 認証タイプを変更できるのは、コネクターが下書きステージにある場合のみで、その際はすべてのコネクター設定が失われます。コネクターが「準備完了」に設定された後は、認証タイプを変更できません。

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

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

5. 「準備完了」に設定すると、 接続を追加 ボタンから接続を追加できるようになります。
   

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

1. OAuth2 の 認証パラメーター を保存すると、 OAuth Scopes セクションに移動します。または、左側のペインにある OAuth Scopes をクリックして移動することもできます。
   

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

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

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

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

6. テーブル内の特定のスコープデータを編集 または 削除 するには、三点リーダー（横並びの三つの点）をクリックします。

7. 複数のスコープを削除する場合は、対象のチェックボックスをオンにして選択し、 削除をクリックします（下図参照）。
    

8. 特定のスコープを検索する場合は、「検索」タブでスコープ名またはスコープ値を入力して検索できます。 

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

10. コネクターが準備完了に設定されると、外部連携を追加から接続を追加できるようになります。

AWS 認証を設定する手順

'カスタムコネクターを新規作成' 画面への移動方法  

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

• ［接続を追加］ページの Built-in Connectors カテゴリーから   

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

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

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

3. i) 外部連携が 3 件より多い場合は、その他を表示 をクリックします。アカウント内のすべての外部連携の一覧が表示されます。

メモ: もしくは、上部の 外部連携 タブに移動して、すべての接続の一覧を表示することもできます。

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

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

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

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

［接続を追加］ページの Built-in Connectors カテゴリーから

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

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

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

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

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

関連トピック               

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