Microsoft Flow を使用すると、コーディングなしでワークフローを作成できます。 しかし、場合によっては Microsoft Flow の機能を拡張する必要がありますが、そのためには Web サービスが最適です。 フローでサービスに接続し、操作を実行して、データを取得できます。 Microsoft Flow で接続したい Web サービスがある場合は、サービスをカスタム コネクタとして登録します。 そうすることで、Microsoft Flow は、必要な認証、サポートされる操作、操作ごとのパラメーターと出力など、Web API の特性を知ることができます。

このトピックでは、カスタム コネクタを登録して使用するために必要な手順について説明します。また、Azure Cognitive Services の Text Analytics API を使います。 この API は、渡されたテキストの言語、センチメント、キー フレーズを識別します。

前提条件

  • Microsoft Flow アカウント
  • JSON 形式の OpenAPI 2.0 (旧称 Swagger) ファイル、OpenAPI 定義への URL、または API の Postman Collection。 1 つもお持ちではない場合は、ガイダンスを提供します。
  • (省略可能) カスタム コネクタのアイコンとして使う画像。

カスタム コネクタのプロセスの手順

カスタム コネクタのプロセスには複数の手順があります。以下では、それについて簡単に説明します。 この記事では、何らかの種類の認証済みアクセスを備えた RESTful API が既にあるものと想定し、記事の残りの部分では手順 3 ~ 6 に注目します。 手順 1 と 2 の例については、「Microsoft Flow 用にカスタム Web API を作成する」をご覧ください。

  1. 選択した言語とプラットフォームで、RESTful API を作成します。 マイクロソフトの技術を使う場合は、次のいずれかをお勧めします (ただし、任意のプラットフォームを使うことができます)。

    • Azure Functions
    • Azure Web Apps
    • Azure API Apps
  2. 次のいずれかの認証メカニズムを使って、API をセキュリティで保護します。 コネクタへの認証されていないアクセスを許可することはできますが、お勧めできません。

    • Azure Active Directory
    • Dropbox、Facebook、SalesForce などの特定のサービスに対する OAuth 2.0
    • 汎用 OAuth 2.0
    • API キー
    • 基本認証
  3. Microsoft Flow が接続できるように、業界標準の 2 つの方法のどちらかで API を記述します。

    • OpenAPI ファイル
    • Postman Collection

    登録プロセスの一環として、手順 4 で OpenAPI ファイルを作成することもできます。

  4. Microsoft Flow のウィザードを使って、カスタム コネクタを登録します。API の説明、セキュリティの詳細、その他の情報を指定します。

  5. アプリでカスタム コネクタを使用します。 アプリでコネクタへの接続を作成し、API が提供する操作を呼び出します。Microsoft Flow で標準の接続を呼び出す場合と同じです。

  6. Microsoft Flow の他のリソースと同じように、カスタム コネクタを共有します。 この手順は省略してもかまいませんが、通常は、複数のアプリ作成者の間でカスタム コネクタを共有すると役に立ちます。

API を記述する

何らかの種類の認証済みアクセスを備えた API がある場合、Microsoft Flow がそれに接続できるように API を記述する方法が必要です。 そのためには、OpenAPI ファイルまたは Postman Collection を作成します。これは、次のような "任意の" REST API エンドポイントから行うことができます。

  • パブリックに利用可能なコネクタ。 例: SpotifyUberSlackRackspace、その他。
  • 作成して、Azure、Amazon Web Services (AWS)、Heroku、Google Cloud などのクラウド ホスティング プロバイダーに展開する API。
  • API がパブリック インターネットで公開される場合、ネットワークにデプロイされたカスタム基幹業務 API。

OpenAPI 2.0 (旧称 Swagger) と Postman Collection では使う形式が異なりますが、どちらもコンピューターで読み取り可能な言語に依存しないドキュメントであり、API の操作とパラメーターを記述します。 - これらのドキュメントは、API の基になっている言語とプラットフォームに応じたさまざまなツールを使って生成できます。 OpenAPI ファイルの例については、Text Analytics API のドキュメントをご覧ください。 - API の OpenAPI ファイルがまだなく、ファイルを作成しない場合でも、Postman Collection を使ってカスタム コネクタを簡単に作成できます。 詳しくは、「Postman Collection を作成する」をご覧ください。 - Microsoft Flow の背後では最終的に OpenAPI が使われるので、Postman Collection は解析されて OpenAPI 定義ファイルに変換されます。

: ファイルのサイズを 1 MB 未満にする必要があります。

OpenAPI と Postman の概要

カスタム コネクタを登録する

OpenAPI ファイルまたは Postman Collection を使って、Microsoft Flow にカスタム コネクタを登録します。

  1. flow.microsoft.com の上部のバーで、歯車アイコンを選択して設定メニューを開きます。 [Custom Connectors (カスタム コネクタ)] オプションを選びます。

    カスタム コネクタの作成

  2. [Create custom connector (カスタム コネクタの作成)] を選びます。

    カスタム コネクタのプロパティ

  3. [General (全般)] タブで、カスタム コネクタの作成方法を選びます。

    • OpenAPI をアップロードする
    • OpenAPI URL を貼り付ける
    • Postman Collection V1 をアップロードする

    カスタム コネクタの作成方法

    カスタム コネクタのアイコンをアップロードします。 [Description (説明)]、[Host (ホスト)]、[Base URL (ベース URL)] の各フィールドは、通常、OpenAPI ファイルの情報が自動的に設定されます。 自動設定されない場合は、フィールドに情報を追加できます。 [続行] を選択します。

  4. [Security (セキュリティ)] タブで、認証プロパティを入力します。

    認証の種類

    • 認証の種類は、OpenAPI の securityDefinitions オブジェクトでの定義に基づいて自動的に設定されます。 次に示すのは OAuth2.0 の例です。

      "securityDefinitions": {
          "AAD": {
          "type": "oauth2",
          "flow": "accessCode",
          "authorizationUrl": "https://login.windows.net/common/oauth2/authorize",
          "tokenUrl": "https://login.windows.net/common/oauth2/token"
          "scopes": {}
          }
      },
      
    • OpenAPI ファイルで securityDefintions オブジェクトが使われていない場合は、値を追加する必要はありません。

    • Postman Collection の場合は、サポートされる認証の種類 (OAuth 2.0 や基本など) を使っている場合にのみ、認証の種類が自動的に設定されます。

    • Azure Active Directory (AAD) 認証の設定の例については、「Microsoft Flow 用にカスタム Web API を作成する」をご覧ください。

  5. [Definitions (定義)] タブでは、OpenAPI ファイルまたは Postman Collection で定義されているすべての操作と要求および応答の値が自動的に設定されます。 必要なすべての操作が定義されている場合は、この画面を変更せずに、登録プロセスの手順 6 に進むことができます。

    [Definition (定義)] タブ

    既存のアクションを編集する場合、またはカスタム コネクタに新しいアクションを追加する場合は、引き続き以下をお読みください。

    1. OpenAPI ファイルまたは Postman Collection にまだ含まれていなかった新しいアクションを追加する場合は、左側のウィンドウで [New action (新しいアクション)] を選択し、[General (全般)] セクションで操作の名前、説明、可視性を指定します。
    2. [Request (要求)] セクションで、右上の [Import from sample (サンプルからインポート)] を選択します。 右側のフォームで、サンプルの要求に貼り付けます。 通常、API ドキュメントではサンプルの要求を使用でき、[Verb (動詞)][Request URL (要求 URL)][Headers (ヘッダー)][Body (本文)] の各フィールドに入力する情報を取得できます。 例については、Text Analytics API のドキュメントをご覧ください。
    重要:

    ヘッダー Content-type は Microsoft Flow によって自動的に追加されます。このヘッダーは必ずアクションから削除してください。 [セキュリティ] セクションに定義されている認証ヘッダーもアクションとトリガーから削除する必要があります。

    サンプルからのインポート 3. [Import (インポート)] を選択して、要求の定義を完了します。 同様の方法で応答を定義します。

  6. すべての操作の定義が済んだら、[Create (作成)] を選択してカスタム コンテナを作成します。

  7. カスタム コンテナを作成した後、[Test (テスト)] タブに移動して、API で定義した操作をテストします。 接続を選択し、入力パラメーターを指定して、操作をテストします。

    カスタム コネクタのテスト

    呼び出しが成功すると、有効な応答を受け取ります。

    コネクタのテストの応答

クォータと調整

  • カスタム コネクタの作成クォータについて詳しくは、「最適なプランをお選びください」ページをご覧ください。 他のユーザーから共有されているカスタム コネクタは、このクォータに含まれません。
  • カスタム コネクタで作成される接続ごとに、ユーザーは 1 分あたり最大 500 個の要求を行うことができます。

カスタム コネクタを共有する

カスタム コネクタが完成したので、組織の他のユーザーと共有できます。 カスタム コネクタを共有した後、カスタム コネクタを削除するとコネクタへのすべての接続が削除されますが、他のユーザーが既に依存している可能性がある点に注意してください。 組織の外部のユーザーにコネクタを提供する場合は、「API コネクタの概要 (Microsoft Flow)」をご覧ください。

  1. flow.microsoft.com の上部のバーで、歯車アイコンを選択して設定メニューを開きます。 [Custom connectors (カスタム コネクタ)] オプションを選びます。

    新しい接続

  2. コネクタの省略記号 [...] ボタンを選択し、[プロパティの表示] を選択します。

    コネクタのプロパティの表示

  3. [共有] を選択し、コネクタへのアクセスを許可するユーザーまたはグループを入力します。

    カスタム コネクタの共有

  4. [保存] を選択します。

次のステップ

Postman Collection の作成方法を学習します

OpenAPI のカスタム拡張機能について学習します

ASP.NET Web API を使用します

Azure Resource Manager API を登録します