顧客向けAPI platformの有効化
API platformは、Embeddedパートナーがコンテンツまたはマイクロサービスを顧客と安全に共有するのに役立つツールです。 APIエンドポイントによってトリガーされるレシピを作成することで、製品の機能を拡張するユースケースを実現します。
次のガイドでは、顧客ワークスペースでAPI platformをプログラムによって有効化するために必要な概念とプラットフォームAPIエンドポイントについて説明します。
プロセスの概要
顧客向けにAPI platformを有効化するには、以下が必要です:
- APIエンドポイントレシピとコレクションの作成
- 顧客の作成
- レシピとコレクションの顧客ワークスペースへのインポート
- 顧客ワークスペースでのクライアント/アクセスプロファイルの作成
- レシピの開始とエンドポイントの有効化
APIエンドポイントレシピの作成
ベストプラクティス
顧客ワークスペースにインポートする前に、Embeddedパートナーの管理者アカウントでAPIエンドポイントレシピを作成してテストします。 インポートとエクスポートのプロセスを簡素化するため、同じフォルダ内にレシピを作成します。
APIエンドポイントを設定する最初の手順は、API platform - 新規APIリクエストトリガーを使用するレシピを作成することです。 APIエンドポイントを作成の開始ポイントをクリックすると、このトリガーが自動的に選択されます。 
レシピの開始ポイントとしてAPIエンドポイントレシピの作成を選択
これらのレシピを1つ以上のAPIコレクションに整理します。 通常、APIコレクションには共通の機能を共有するアクセスパターンのエンドポイントが含まれ、それらをまとめて管理できます。 たとえば、営業チームがレシピで使用する一連のSalesforceエンドポイントがある場合、それらをAPIコレクションにまとめることができます。
APIエンドポイントを有効化してテストします。 エンドポイントとコレクションの作成および有効化に関する詳細情報については、APIエンドポイント管理およびAPIコレクション作成ガイドを参照してください。
エンドポイントを作成してテストした後、レシピライフサイクルマネジメントツールを使用して、すべてのコレクションとエンドポイントを含むマニフェストを作成します。
顧客の作成
Admin consoleのUI、または顧客管理プラットフォームAPIを使用して顧客を作成できます。 APIを使用して顧客を作成すると、レスポンス本文で顧客IDが返されます。
Admin consoleのUIで顧客を表示または作成する場合、顧客IDは顧客情報ページのURLで確認できます。
UIのURLで顧客IDを取得
EmbeddedプラットフォームAPIショートカット
- 顧客を作成: POST /api/managed_users
レシピとコレクションの顧客ワークスペースへのインポート
Workato UIまたはEmbeddedプラットフォームAPIを使用して、レシピとコレクションを顧客ワークスペースにインポートできます。
管理者アカウントから顧客ワークスペースにレシピをインポートする前に、顧客ワークスペースにフォルダを作成します。 フォルダは最上位フォルダ（Home内に1レベルネストされたもの）である必要があります。
管理者ワークスペースに保存されたマニフェストを使用して、顧客ワークスペースにパッケージをエクスポートします。 エクスポートすると、パッケージ内のエンドポイントとコレクションが顧客ワークスペースにコピーされます。
EmbeddedプラットフォームAPIショートカット
- 顧客ワークスペースに必須の最上位フォルダを作成: POST /api/managed_users/:id/folders
- 管理者ワークスペースからパッケージをエクスポート: POST /api/packages/export/:id
- 顧客ワークスペースにパッケージをインポート: POST /api/managed_users/:id/imports
顧客ワークスペースでのクライアント/アクセスプロファイルの作成
APIクライアントは、アクセスプロファイルを通じて1つ以上のAPIコレクションへのアクセス権を受け取るユーザーのグループです。 たとえば、同じ組織のメンバーが1つのAPIクライアントを構成し、個別のアクセスプロファイルを通じてAPIコレクションにアクセスします。 Workato UIまたはEmbeddedプラットフォームAPIを使用して、APIクライアントとアクセスプロファイルを作成できます。
これらのエンドポイントを有効化するには、APIクライアントとアクセスプロファイルを顧客ワークスペースに追加します。 詳細な手順については、クライアントとアクセスプロファイルガイドを参照してください。
前の手順でインポートしたコレクションをアクセスプロファイルに割り当てます。 各顧客にすでにアカウントがあることを考慮すると、デフォルトクライアントを1つ、デフォルトアクセスプロファイルを1つ作成するだけでよい場合があります。
今後コレクションを追加する場合は、新しいコレクションIDを含めるようにアクセスプロファイルを更新します。
EmbeddedプラットフォームAPIショートカット
- APIクライアントを作成: POST /api/managed_users/:id/api_clients
- クライアント内にアクセスプロファイルを作成: POST /api/managed_users/:id/api_clients/:api_client_id/api_access_profiles
- アクセスプロファイルを更新: PUT /api/api_access_profiles
レシピの開始とエンドポイントの有効化
顧客ワークスペースにレシピをインポートした後、エンドポイントを有効化する前にレシピを開始する必要があります。 エンドポイントが有効化された後、APIクライアントを使用してエンドポイントを呼び出すことができます。
Workatoレシピ作成UIまたはEmbeddedプラットフォームAPIエンドポイントを使用して、レシピを開始し、エンドポイントを有効化できます。
EmbeddedパートナーがAPIクライアントのエンドポイントへのアクセスを制限する必要がある場合、パートナーはエンドポイントを無効化できます。
EmbeddedプラットフォームAPIショートカット
Last updated: