Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Embedded API
リソース

カスタムコネクター ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

カスタムコネクターリソースを使用すると、共有コネクターをプログラムで管理できます。

これらのエンドポイントを使用できるユーザー

このガイドのエンドポイントはEmbedded APIであり、Embeddedワークスペースが必要です。 詳細については、Workato担当者にお問い合わせください。

レート制限 ​

カスタムコネクターリソースには、次のレート制限があります。

タイプリソース制限
すべてすべてのカスタムコネクターエンドポイント1分あたり60リクエスト

クイックリファレンス ​

Custom Connectorsリソースには、次のエンドポイントが含まれます。

タイプリソース説明
GET/api/custom_connectorsカスタムコネクターを取得します。
GET/api/custom_connectors/:idIDでカスタムコネクターを取得します。
POST/api/custom_connectors/:id/oem_share/:version共有コネクターを作成または更新します。
POST/api/managed_users/:managed_user_id/recipes/:recipe_id/shareカスタムコネクターを含むレシピを共有または公開します。
DELETE/api/custom_connectors/:id/suppress_oem_version共有コネクターを削除します。

カスタムコネクターの検索 ​

ワークスペース内のカスタムアダプターを一覧表示します。

GET /api/custom_connectors

URLパラメーター ​

名前タイプ説明
titlestring
任意		コネクターをタイトルで検索します。 部分一致が返されます。
oem_sharedboolean
optional		OEMマスターアカウントから共有されているコネクターを検索します。

サンプルリクエスト ​

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

レスポンス ​

json
{
    "result": [
        {
            "id": 3067,
            "name": "new_connector_1_connector_4771_1626869205",
            "title": "Foobar",
            "latest_released_version": null,
            "latest_released_version_note": null,
            "oem_shared_version": null,
            "oem_shared_at": null,
            "released_versions": []
        },
        {
            "id": 3066,
            "name": "new_connector_1_connector_4771_1626869114",
            "title": "Acme Connector",
            "latest_released_version": 4,
            "latest_released_version_note": null,
            "oem_shared_version": 2,
            "oem_shared_at": "2022-08-08T08:05:22.047-07:00",
            "released_versions": [
                {
                    "version": 4,
                    "version_note": null,
                    "created_at": "2022-08-11T07:24:58.890-07:00",
                    "released_at": "2021-09-26T21:33:41.713-07:00"
                },
                {
                    "version": 2,
                    "version_note": "hello",
                    "created_at": "2021-07-21T05:05:34.136-07:00",
                    "released_at": "2021-09-26T21:33:41.713-07:00"
                }
            ]
        }
    ]
}

IDによるカスタムコネクターの取得 ​

IDで特定のカスタムコネクターを取得します。

GET /api/custom_connectors/:id

パスパラメーター ​

名前タイプ説明
idinteger
required		ワークスペース内のコネクターのID。

サンプルリクエスト ​

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

レスポンス ​

json
{
    "result": [
        {
            "id": 3066,
            "name": "new_connector_1_connector_4771_1626869114",
            "title": "Acme Connector",
            "latest_released_version": 2,
            "latest_released_version_note": "V2",
            "oem_shared_version": 2,
            "oem_shared_at": "2022-08-08T08:05:22.047-07:00",
            "released_versions": [
                {
                    "version": 2,
                    "version_note": "V2",
                    "created_at": "2021-07-21T05:05:34.136-07:00",
                    "released_at": "2021-09-26T21:33:41.713-07:00"
                }
            ]
        }
    ]
}

共有コネクターのバージョンのUpsert ​

OEMマスターアカウント内の共有コネクターのバージョンを作成または更新します。

  • コネクターが現在共有されていない場合は、指定したバージョンで新しい共有コネクターを作成します。
  • コネクターが現在共有されている場合は、このコネクターで現在共有されているバージョンを更新します。

重要

共有するバージョンはリリース済みバージョンである必要があります。

POST /api/custom_connectors/:id/share_oem_version/:version

パスパラメーター ​

名前タイプ説明
idinteger
required		共有する、ワークスペース内のコネクターのID。
versioninteger
required		共有する、ワークスペース内のコネクターのバージョン。 これはリリース済みバージョンである必要があります。

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/custom_connectors/3066/share_oem_version/4 \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

  • 新しい共有コネクターが作成されました。
json
{
    "result": {
        "success": true,
        "status": "created"
    }
}
  • 既存の共有コネクターバージョンが更新されました。
json
{
    "result": {
        "success": true,
        "status": "updated"
    }
}

カスタムコネクターを含むレシピの公開または共有 ​

カスタムコネクターを含むレシピをPrivate Communityに公開するか、指定した顧客と共有できます。

重要

このエンドポイントを使用する前に、/api/custom_connectors/:id/oem_share/:versionエンドポイントを使用して、カスタムコネクターをEmbedded顧客またはPrivate Communityと共有する必要があります。 そうしないと、Workatoにエラーメッセージが表示されます。

POST api/managed_users/:managed_user_id/recipes/:recipe_id/share

パスパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客のアカウントIDまたは外部ID。 外部IDにはEをプレフィックスとして付け（例：EA2300）、生成されたIDをURLエンコードする必要があります。
recipe_idstring
必須		共有または公開する予定のレシピのID。

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/managed_users/12345/recipes/123/share \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "result": {
        "success": true
    }
}

共有コネクターの削除 ​

共有コネクターを削除します。 これにより、カスタムコネクターがワークスペースから削除されることはありません。

重要

このコネクターを使用している顧客アカウントがある状態でこのAPIを使用すると、そのレシピに影響します。

DELETE /api/custom_connectors/:id/suppress_oem_version

パスパラメーター ​

名前タイプ説明
idinteger
required		削除する、ワークスペース内の共有コネクターのID。

サンプルリクエスト ​

shell
curl  -X DELETE https://www.workato.com/api/custom_connectors/3066/suppress_oem_version \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

  • 新しい共有コネクターが作成されました。
json
{
    "result": {
        "success": true,
        "status": "suppressed"
    }
}

Last updated: