カスタムコネクタ

既存のエンタープライズシステムおよびサードパーティサービスを使用して、ワークフローに独自の接続とアクションを追加します。カスタムコネクタでは、通信に REST API を使用し、API 開発ツール Postman を使用して標準的な要求を作成します。

カスタムコネクタを使用した内部サービスの自動化

サービスが REST API と JSON コンテンツタイプをサポートしている場合は、カスタムコネクタを使用したワークフローでサービスを使用できます。

Postman による標準的な REST API の作成

Workspace ONE Intelligence は、Postman を使用して、システムが内部およびサードパーティサービスを使用して接続および操作するために使用する REST API を標準化します。また、保存されたアクションを再利用できる、使い慣れた REST テンプレートインターフェイスを使用してアクションを作成できます。Postman の無償バージョンは、カスタムコネクタのコレクションを作成するのに必要な機能を備えています。

カスタムコネクタを使用する手順

Postman で要求を含むコレクションを作成し、エクスポートします。
Workspace ONE Intelligence でカスタム接続を追加し、要求をインポートします。これで、これらの要求が、ワークフローで使用できるアクションとして使用できるようになりました。
Workspace ONE Intelligence で、インポートされたアクションを含むワークフローを構成して、カスタム接続を使用しているタスクを自動化します。

カスタムコネクタのアクション

Workspace ONE Intelligence では、カスタムコネクタを編集、削除、およびテストできます。アクションは複数のコネクタで使用できます。このため、操作する前に編集または削除の結果を考慮する必要があります。

削除：接続全体とそのすべてのアクションを削除するには、まず、接続を認証解除する必要があります。認証解除すると、この接続に関連付けられているアクションを使用しているワークフローが無効にされます。システムにより、接続が削除された後、関連付けられているすべてのアクションが他のワークフローから削除されます。無効化されたワークフローを再度実行するには、無効化されたワークフローを編集し、再度有効にする必要があります。この操作を元に戻すことはできません。
編集：接続の名前、説明、および認証タイプはいつでも編集できます。アクションの要求詳細を編集するには、Postman コレクションを編集してから、カスタム接続に再インポートします。注: 認証タイプを編集して資格情報を誤って入力した場合、アクションの実行に失敗することがあります。編集は慎重に行ってください。
テスト：Workspace ONE Intelligence のカスタムコネクタをテストし、Workspace ONE Intelligence とサービスが通信できることを確認します。

カスタムコネクタの登録

カスタム接続を追加するには、Postman コレクションをインポートします。Postman JSON ファイル内の要求は、アクションです。コレクションをインポートすると、アクションをワークフローで使用できるようになります。

前提条件

「カスタムコネクタ用に Postman を使用する」に記載されているプロセスを使用して、コレクションを作成します。
接続しようとするサービスは、REST API および JSON コンテンツタイプをサポートしている必要があります。
Workspace ONE Intelligence は API エンドポイントにアクセスする必要があります。サービスがファイアウォールの背後にある場合は、Unified Access Gateway をリバースプロキシとして使用します。
認証に OAuth2 を使用する場合は、認証の詳細を用意して、Workspace ONE Intelligence がサービスのトークンの取得、更新、およびアクセスを行うことができるようにします。
- OAuth2 トークン URL
- クライアントシークレット
- クライアント ID
- 認証タイプ（クライアント認証情報またはパスワード）

手順

Workspace ONE Intelligence で、[統合] > [ワークフローコネクタ] に移動し、[カスタムコネクタの追加] を選択します。
[接続名] には、接続の識別可能な名前を入力します。
[ベース URL] には、Workspace ONE Intelligence が認証できるように、サービスの URL を入力します。サービスの URL とカスタム接続の URL が一致する必要があります。
[認証タイプ] には、サービスへのアクセスに使用する認証タイプを選択します。Workspace ONE Intelligence は、この設定を使用してコレクション内の Postman 認証ヘッダーを上書きします。サービスで独自のヘッダーベースの認証タイプを使用している場合は、Postman コレクション内のすべての要求にヘッダーを追加し、ベース URL を構成します。このシナリオでは、Workspace ONE Intelligence は、Postman コレクション内に構成されたヘッダーを使用します。ヘッダーベースの認証タイプの例では、API キーまたはトークンを使用しています。
- ベーシック認証：Workspace ONE Intelligence にアクセスを許可し、認証情報を入力します。
- OAuth2 認証：詳細を入力し Workspace ONE Intelligence がサービスのトークンを取得、更新、およびアクセスできるようにします。
- 認証なし：Workspace ONE Intelligence が認証ヘッダーを上書きしないようにするには、このメニュー項目を選択します。
Postman JSON ファイルをインポートするには、ユーザーインターフェイスの中央にある [お使いのコンピュータから選択します] リンクを使用します。ユーザーインターフェイスに、その要求を含むコレクションが表示されます。これで、これらの Postman 要求をワークフローのアクションとして使用できるようになりました。
インポートされたアクションのリストから、アクションをテスト、編集、および削除できます。
- 削除：削除するアクションが他のワークフローで使用されている場合、それらのワークフローが無効にされ、アクションが削除されます。それらのワークフローが引き続き機能できるようにするには、それらのワークフローを編集し、再度有効にする必要があります。削除操作を元に戻すことはできません。
- 編集：アクションの名前と説明を編集できます。システムは、インポートされた Postman JSON から名前と説明を収集します。アクションの要求詳細を編集するには、Postman コレクションを編集してから、カスタム接続に再インポートします。
- テスト：接続が機能することを確認するには、テストメニュー項目を使用します。システムにより、Postman コレクション内に構成された要求がテストされます。

カスタムコネクタ用に Postman を使用する

Postman アプリを使用して、カスタムコネクタ用の標準的な REST API を作成します。このコンテンツは、Postman コレクションを JSON ファイルとして作成およびエクスポートするための一般的なワークフローを提供します。

このアプリの無償バージョンには、要求を含むコレクションを作成し、ワークフローのためにエクスポートする機能があります。

このトピックでは、コレクションを作成してエクスポートするために必要な作業の概要を説明します。これは、リファレンスとして提供されています。Postman 製品を構成する方法の最新の説明については、Postman Learning Center を参照してください。

https://www.getpostman.com から、Postman アプリを入手します。

手順

コレクションを追加します。
コレクションで要求を追加および構成します。
- これらの要求で指定された名前と説明は、Workspace ONE Intelligence のワークフローアクションで使用されます。Workspace ONE Intelligence で後で変更できます。Postman 要求のエントリの例と、これがワークフローのアクションとして Workspace ONE Intelligence にどのようにレンダリングされるかを次に示します。
- Content-Type: application/json のようなヘッダーを追加することを検討してください。コンテンツタイプ JSON のようなヘッダーを追加しない場合、API は既定で XML に設定できますが、XML はカスタムコネクタでは動作しません。
- API に必要なカスタムヘッダーを Postman コレクション内のすべての要求に追加します。カスタムヘッダーの例として、API キーやトークンなど、独自のヘッダーベースの認証タイプがあります。Workspace ONE Intelligence は、認証ヘッダーを除くすべてのヘッダーを保持します。また、カスタムコレクション内の [認証タイプ] の構成を使用して認証ヘッダーを上書きします。Workspace ONE Intelligence が認証ヘッダーを上書きしても、システムにより、独自のヘッダーベースの認証が使用のために送信されます（ユーザーが他の要求に追加しているため）。
要求を送信して検証します。検証により、応答が生成されます。
ドキュメントの例として、応答を保存します。Open API プロトコルには、この手順が必要です。
要求を保存します。
必要に応じて、その他の要求を追加します。
コレクションを Collection v2.1 としてエクスポートします。