Embedded Environments API ​

Embedded APIはEmbedded Environmentsと完全に互換性があります。 適切なワークスペースIDを対象にすることで、すべてのEnvironmentで同じEmbedded APIを引き続き使用できます。 既存のEmbedded CustomerにEnvironmentsをプロビジョニングすると、元のワークスペースIDがDevelopmentワークスペースIDになり、TESTおよびPROD Environment用に2つの新しいIDが生成されます。

Environmentsの有無によるEmbedded API ​

すべてのEmbedded API操作のベースURLは次のとおりです。

.../api/managed_users/

このベースURLにmanaged_user_idを追加して、特定の顧客を操作します。 各ワークスペースIDを指定することで、Environmentsがプロビジョニングされた顧客の各Environmentを管理できます。 顧客にEnvironmentsがプロビジョニングされていない場合は、URL/api/managed_users/:managed_user_idを使用して特定の顧客を操作できます。

Environmentをプログラムでプロビジョニング ​

新規および既存の管理対象顧客に対して、Environments機能をプログラムでプロビジョニングできます。 詳細については、Embedded API Environmentsセクションを参照してください。

正しいIDの取得方法 ​

顧客一覧取得APIを使用して、顧客のEnvironmentのIDを取得できます。

顧客を一覧表示すると、Environmentsがプロビジョニングされた顧客では、PRODおよびTEST EnvironmentのIDを含む新しいプロパティenvironmentsが返されます。

サンプルリクエスト ​

curl  -X GET https://www.workato.com/api/managed_users \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

{
        {
            "id": 29727, //this is the used_id for a customer without ENVs
            "external_id": null,
            "name": "new",
            "environments": [],
            "notification_email": "[email protected]",
            ...
        },
        {
            "id": 29833, //this is the used_id_dev for a customer with ENVs
            "external_id": null,
            "name": "Alex",
            "environments": [
                {
                    "id": 29835, //this is the used_id_prod for a customer with ENVs
                    "environment_type": "prod"
                },
                {
                    "id": 29834, //this is the used_id_test for a customer with ENVs
                    "environment_type": "test"
                }
            ],
            "notification_email": "[email protected]",
           ...
        },
}

Environmentの外部ID ​

各顧客のEnvironmentごとに一意の外部IDを指定することもできます。 外部IDを使用すると、Environmentsがない顧客の場合と同じ方法で、顧客をプログラムで管理できます。

外部IDを追加するには、APIを通じて顧客を更新するか、UIから追加します。

Development Environment専用アクセス ​

コラボレーター管理などのDevelopmentアクティビティ向けに設計された特定のAPIエンドポイントには、Development Environment内でのみアクセスできます。 TESTまたはPROD Environmentからこれらのエンドポイントにアクセスしようとすると、エラーが表示されます。

例:

サンプルリクエスト ​

curl  -X POST https://www.workato.com/api/managed_users/:managed_user_id_test \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

{
    "message": "Not Available for Environment"
}