カスタム コネクタの概要Custom connectors overview

コードを記述しなくても、Azure Logic AppsMicrosoft Flow、および PowerApps を使用してワークフローやアプリを作成できます。Without writing any code, you can build workflows and apps with Azure Logic Apps, Microsoft Flow, and PowerApps. データやビジネス プロセスの統合を支援するために、これらのサービスでは 180 種類以上のコネクタを提供しています。Microsoft のサービスおよび製品用のコネクタだけでなく、GitHub、Salesforce、Twitter などの他のサービス用のコネクタも用意されています。To help you integrate your data and business processes, these services offer 180+ connectors - for Microsoft services and products, as well as other services, like GitHub, Salesforce, Twitter, and more.

ただし、事前に作成されたコネクタとして使用できない API、サービス、システムを呼び出すことが必要な場合もあります。Sometimes though, you might want to call APIs, services, and systems that aren't available as prebuilt connectors. カスタマイズされたシナリオをサポートするために、独自のトリガーとアクションを備えた "カスタム コネクタ" を作成することができます。To support more tailored scenarios, you can build custom connectors with their own triggers and actions. これらのコネクタは "関数ベース" です。つまり、基になるサービスの特定の関数の呼び出しに基づいてデータが返されます。These connectors are function-based - data is returned based on calling specific functions in the underlying service. 次の図は、テキスト内のセンチメントを検出する API 用のカスタム コネクタを示しています。The following diagram shows a custom connector for an API that detects sentiment in text. このシナリオの詳細について簡潔に説明します。We'll learn more about this scenario shortly.

Web API、カスタム コネクタ、ロジック アプリの概念の概要

このトピックは、カスタム コネクタに関する一連の基本的チュートリアルと高度なチュートリアルへの入り口となっています。This topic is the entry point to a set of basic and advanced tutorials on custom connectors. 次の図は、カスタム コネクタの作成と使用に関連したタスクの概要を示しています。The following diagram shows the high-level tasks involved in creating and using custom connectors:

カスタム コネクタの作成手順

これらの手順の詳細については、このトピックで後ほど詳しく説明します。You can read more about these steps later in this topic.

前提条件Prerequisites

  • カスタム コネクタを使用するには、次のサブスクリプションのいずれかが必要です。また、ロジック アプリ、フロー、またはアプリの作成方法の基本を理解している必要もあります。To get started with custom connectors, you need one of the following subscriptions and a basic understanding of how to create logic apps, flows, or apps:
  • このシリーズのチュートリアルに従うには、例で使用する Cognitive Services Text Analytics API の API キーが必要ですTo follow the tutorials in this series, you need an API key for the Cognitive Services Text Analytics API we use in our examples
  • その他の前提条件は、後続のチュートリアルに記載されていますAdditional prerequisites are listed in subsequent tutorials

基本的なチュートリアル シリーズの API シナリオAPI scenario for our basic tutorial series

このチュートリアル シリーズの例では、Cognitive Services Text Analytics API を使用します。In this tutorial series, we use the Cognitive Services Text Analytics API in our examples. Microsoft では既にこの API 用のコネクタを用意していますが、ここではカスタム コネクタのライフサイクルを理解できるように基本バージョンの作成方法を示します。Microsoft already provides a connector for this API, but we show you how to build a basic version so you can understand the custom connector life-cycle.

作成するコネクタは Text Analytics Sentiment API を公開します。この API は、テキスト入力を受け取り、このテキストのセンチメント スコア (0 ~ 1) を返します。The connector you build exposes the Text Analytics Sentiment API, which takes text input and returns the sentiment score (0 to 1) for the text. 次に、このスコアを使用するロジック アプリ、フロー、またはアプリを作成します。You then build a logic app, flow, or app that uses this score. 非常に基本的な例ですが、作成過程で多くのことを学習できます。また、カスタム コネクタによって複雑な動作が可能になるしくみを簡単に確認することができます。The example is pretty basic, but you learn a lot in the process, and it's easy to see how custom connectors can enable complex behaviors.

API キーを取得するGet an API key

Text Analytics API は "API キー" を使用してユーザーを認証します。The Text Analytics API uses an API key to authenticate users. カスタム コネクタから API への接続を作成する際に、このキーを指定します。When you create a connection to the API from a custom connector, you specify this key. API キーは、次の 2 つの方法のいずれかを使用して取得できます。You can get an API key in one of two ways:

  • API を試すように API キーに要求する。この場合、Azure サブスクリプションは不要です。Request an API key to try out the API, which doesn't require an Azure subscription.

  • Azure サブスクリプションにText Analytics API を追加するAdd the Text Analytics API to your Azure subscription. サブスクリプションに API を追加する場合は、次のように [キー] を選択してから、いずれかのキーをコピーします。If you add the API to your subscription, get the API key in the following way: choose Keys then copy one of the keys:

    API キーを取得する

チュートリアル シリーズの開始Starting the tutorial series

カスタム コネクタのライフサイクルの詳細については、このトピックの以降の部分を読むことをお勧めしますが、コネクタを作成する準備ができている場合は、すぐにチュートリアル シリーズに移ってもかまいません。We recommend reading the rest of this topic for more details on the custom connector life-cycle, but you can jump into the tutorial series if you're ready to build a connector. 使用するサービスによって、移動先は次のように異なります。Where you go next depends on what service you're using:

カスタム コネクタのライフサイクルの概要Overview of the custom connector life-cycle

では続けましょう。Alright, you're still with us! このセクションでは、詳細情報へのリンクを含め、ライフサイクルの各段階について少し詳しく説明します。In this section, we provide a little more detail on each of the steps in the life-cycle, with links out to more information.

1.API を作成して保護する1. Build and secure your API

カスタム コネクタは、基になるサービスが Logic Apps、Microsoft Flow、または PowerApps と対話できるようにする REST API (Logic Apps では SOAP API もサポートされます) のラッパーです。A custom connector is a wrapper around a REST API (Logic Apps also support SOAP APIs) that lets an underlying service talk to Logic Apps, Microsoft Flow, or PowerApps. そのため、カスタム コネクタを作成する前に、まず、完全に機能している API が必要となります。So first, you need a fully functioning API before you create a custom connector.

REST API または SOAP API として利用できる限り、API には任意の言語とプラットフォームを使用できます。You can use any language and platform for your API, as long as it's made available as a REST API or SOAP API. 次に例をいくつか示します。Here are a few examples:

  • 公開されている API (SpotifySlackRackspace など)Publicly available APIs like Spotify, Slack, Rackspace, and so on

  • クラウド ホスティング プロバイダー (Azure、Heroku、Google Cloud など) にデプロイされている作成済みの APIAn API that you create and deploy to any cloud hosting provider, such as Azure, Heroku, Google Cloud, and more

  • ネットワークにデプロイされているカスタム基幹業務 API。A custom line-of-business API that's deployed to your network. API がパブリック インターネット上で公開されている場合、API に接続できます。また、ゲートウェイ (現在、Microsoft Flow および PowerApps で利用できます) を介して接続できます。You can connect to the API if it's available over the public internet, or you can connect to it through a gateway (currently available in Microsoft Flow and PowerApps).

Microsoft のテクノロジーの場合、次のプラットフォームのいずれかを使用することをお勧めします。For Microsoft technologies, we recommend one of these platforms:

API とコネクタには、以下の標準的認証方法のいずれかを使用してください (Azure Active Directory を推奨)。Use one of these standard authentication methods for your APIs and connectors (Azure Active Directory is recommended):

Azure Portal で API の Azure AD 認証を設定できるので、コードによって認証を実装する必要はありません。You can set up Azure AD authentication for your API in the Azure portal so you don't have to implement authentication through code. あるいは、API のコードで認証を要求し、強制できます。Or, you can require and enforce authentication through your API's code. カスタム コネクタ用の Azure AD の詳細については、Azure AD による API とコネクタの保護に関するページをご覧ください。For more information about Azure AD for custom connectors, see Secure your API and connector with Azure AD.

2.API について記述し、カスタム コネクタを定義する2. Describe the API and define the custom connector

何らかの種類の認証済みアクセスを使用する API を用意できたら、次に、Logic Apps、Microsoft Flow、または PowerApps が API と通信できるように、API のインターフェイスと操作をどのように記述するかを検討します。If you have an API with some type of authenticated access, the next thing to consider is how you describe your API's interface and operations so that Logic Apps, Microsoft Flow, or PowerApps can communicate with your API. API の記述方法が決まったら、API を適切なサービスに "登録" するコネクタを作成します。After you decide on how to describe the API, you create the connector, which registers it with the appropriate service(s).

次のいずれかの方法を使用して API を記述します。Use one of the following approaches to describe your API:

OpenAPI 定義と Postman コレクションでは使用する形式が異なりますが、どちらも言語に依存しない、コンピューターが読み取り可能なドキュメントであり、API の操作とパラメーターを記述します。OpenAPI definitions and Postman collections use different formats, but both are language-agnostic, machine-readable documents that describe your API's operations and parameters. これらのドキュメントは、API で使用される言語とプラットフォームに応じて、さまざまなツールで生成できます。You can generate these documents from various tools, based on the language and platform used by your API. Logic Apps、Flow、および PowerApps は、バックグラウンドで OpenAPI を使用してコネクタを定義します。Behind the scenes, Logic Apps, Flow, and PowerApps use OpenAPI to define connectors.

手順 3.ロジック アプリ、フロー、またはPowerApps アプリでコネクタを使用する3. Use your connector in a logic app, flow, or PowerApps app

カスタム コネクタは、Microsoft が管理するコネクタを使用する場合と同様に使用できます。You use your custom connector like you use Microsoft-managed connectors. API への接続を作成し、Microsoft が管理するコネクタの操作を呼び出す場合と同様に、API が提供する任意の操作を呼び出します。You create a connection to your API, and call any operations that the API provides in the same way that you call operations for Microsoft-managed connectors.

Microsoft Flow または PowerApps で作成したコネクタは、どちらのサービスでも使用できます。Connectors you create in Microsoft Flow or PowerApps can be used in both services. Logic Apps で作成したコネクタは、他のサービスで直接使用することはできません。Connectors you create in Logic Apps cannot be used directly in the other services. ただし、以前にコネクタを作成したのと同じ OpenAPI 定義または Postman コレクションを使用することで、簡単にコネクタを再作成できます。That said, you can easily recreate a connector by using the same OpenAPI definition or Postman collection you used to create the connector.

詳細については、次の該当するチュートリアルを参照してください。For more information, see the appropriate tutorial:

4.コネクタを共有する4. Share your connector

Logic Apps、Microsoft Flow、または PowerApps でリソースを共有する場合と同様に、コネクタを組織のユーザーと共有できます。You can share your connector with users in your organization in the same way that you share resources in Logic Apps, Microsoft Flow, or PowerApps. 共有は任意ですが、コネクタを他のユーザーと共有することが望ましい場合があります。Although sharing is optional, you might have scenarios where you want to share your connectors with other users.

詳細については、組織内でのカスタム コネクタの共有に関するページをご覧ください。For more information, see Share custom connectors in your organization.

5.コネクタを認定する5. Certify your connector

必要に応じて、Logic Apps、Flow、PowerApps のすべてのユーザーとコネクタを共有するには、コネクタを提出して Microsoft の認定を受けます。To optionally share your connector with all users in Logic Apps, Flow, and PowerApps, submit your connector for Microsoft certification. このプロセスでは、コネクタのレビュー、技術およびコンテンツのコンプライアンスの確認、Logic Apps、Flow、PowerApps に対する機能の検証が、Microsoft によって行われます。During this process, Microsoft reviews your connector, checks for technical and content compliance, and validates functionality for Logic Apps, Flow, and PowerApps.

詳細については、「Microsoft の認定を受けるためにコネクタを提出する」を参照してください。For more information, see Submit your connectors for Microsoft certification.

高度なチュートリアルAdvanced tutorials

カスタム コネクタの具体的なシナリオの詳細については、次のチュートリアルを参照してください。The following tutorials provide more detail for specific custom connector scenarios:

次の手順Next steps