カスタムコネクター

次のエンドポイントを使用すると、カスタムコネクターの作成と管理に加え、サンプルJSONおよびCSVドキュメントからWorkatoスキーマを生成できます。これらのエンドポイントは、SDK CLIツールのスキーマ生成コマンドでも使用されます。

レート制限

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

タイプ	リソース	制限
POST	JSONからスキーマを生成: /api/sdk/generate_schema /json	1分あたり60リクエスト
POST	CSVからスキーマを生成: /api/sdk/generate_schema /csv	1分あたり60リクエスト
すべて	その他すべてのカスタムコネクターエンドポイント	1秒あたり1リクエスト

カスタムコネクターリソースには、次の追加制限が適用されます:

説明	制限
カスタムコネクタコードで許可される最大データ量	10 MB
互換性のあるコード形式	UTF-8およびJSON互換

クイックリファレンス

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

タイプ	リソース	説明
POST	/api/sdk/generate_schema/json	文字列化されたJSONサンプルからWorkatoスキーマを生成します。
POST	/api/sdk/generate_schema/csv	文字列化されたCSVサンプルからWorkatoスキーマを生成します。
GET	/api/custom_connectors/search	カスタムコネクターを検索します。
GET	/api/custom_connectors/:id/code	カスタムコネクターのコードを取得します。
POST	/api/custom_connectors	カスタムコネクターを作成します。
POST	/api/custom_connectors/:id/release	カスタムコネクターの最新バージョンをリリースします。
POST	/api/custom_connectors/:id/share	カスタムコネクターを共有します。
PUT	/api/custom_connectors/:id	カスタムコネクターを更新します。

JSONからスキーマを生成

文字列化されたJSONサンプルからWorkatoスキーマを生成します。

POST /api/sdk/generate_schema/json

URLパラメーター

名前	タイプ	説明
sample	string 任意	解析するサンプルドキュメントの文字列化されたJSON。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/sdk/generate_schema/json \
      -H 'Authorization: Bearer <api_token>' \
      --data-raw '{
     "sample": "{ \"test\":\"hello\"}"
     }'

レスポンス

json

[
    {
        "control_type": "text",
        "label": "Test",
        "type": "string",
        "name": "test"
    }
]

CSVからスキーマを生成

文字列化されたCSVサンプルからWorkatoスキーマを生成します。

POST /api/sdk/generate_schema/csv

URLパラメーター

名前	タイプ	説明
sample	string 任意	解析するサンプルドキュメントの文字列化されたCSV。
col_sep	string 任意	CSVサンプルの列区切り文字。 `comma`、`semicolon`、`space`、`tab`、`colon`、`pipe`のいずれかである必要があります。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/sdk/generate_schema/csv \
      -H 'Authorization: Bearer <api_token>' \
      --data-raw '{
     "sample": "first_name,5\nhello,world",
     "col_sep": "comma"
     }'

レスポンス

json

[
    {
        "control_type": "text",
        "label": "First name",
        "type": "string",
        "name": "first_name"
    },
    {
        "control_type": "text",
        "label": "Last name",
        "type": "string",
        "name": "last_name"
    }
]

カスタムコネクターを検索

Search操作では、ワークスペース内のカスタムコネクターをタイトルで検索できます。

最新リリース10件に制限

直近にリリースされた10件のバージョンのみが返されます。

GET /api/custom_connectors/search

ペイロード

名前	タイプ	説明
title	String 必須	検索するカスタムコネクターの大文字と小文字を区別するタイトル。検索では部分一致が返されます。

サンプルリクエスト

shell

curl -X GET https://<DC-SPECIFIC-API-BASE-URL>/api/custom_connectors/search \
  -H "Authorization: Bearer <API-CLIENT-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "<connector_title>"
  }'

サンプルレスポンス

json

{
    "id": 3066,
    "name": "new_connector_1_connector_4771_1626869114",
    "title": "Acme Connector",
    "logo": "<base_64 encoded logo>",
    "latest_version": 6,
    "latest_version_note": "Latest version",
    "latest_released_version": 4,
    "latest_released_version_note": null,
    "latest_shared_version": 6,
    "latest_shared_version_note": "Latest version",
    "oem_shared_version": 2,
    "oem_shared_at": "2024-02-02T08: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 world",
            "created_at": "2024-02-08T05:05:34.136-07:00",
            "released_at": "2024-02-08T21:33:41.713-07:00"
        }
    ]
},

カスタムコネクターコードを取得

Get custom connector code操作では、カスタムコネクターのコードを取得できます。

GET /api/custom_connectors/:id/code

URLパラメーター

名前	タイプ	説明
ID	Integer 必須	コードを取得するカスタムコネクターのID。カスタムコネクターIDは、カスタムコネクター検索エンドポイントで確認できます。

サンプルリクエスト

shell

curl -X GET https://<DC-SPECIFIC-API-BASE-URL>/api/custom_connectors/1/code \
  -H "Authorization: Bearer <API-CLIENT-TOKEN>"

サンプルレスポンス

json

{
  "data": {
    "code": "<connector_code_stringified>"
  }
}

カスタムコネクターを作成

Create操作では、ワークスペースにカスタムコネクターを作成できます。

POST /api/custom_connectors

ペイロード

名前	タイプ	説明
title	文字列	作成するカスタムコネクターのタイトル。
logo	文字列	カスタムコネクターに追加するロゴ。ロゴはBase64形式でエンコードされている必要があります。
説明	文字列	カスタムコネクターの説明。説明は、プライベートリンクまたはコミュニティライブラリを通じてカスタムコネクターを共有すると表示されます。 Markdownを使用できます。
note	文字列	カスタムコネクターの初期バージョンに関するメモ。
code	文字列	カスタムコネクターのRubyコード。コードが文字列化されていることを確認してください。コードのサイズは10MBを超えることはできません。

サンプルリクエスト

shell

curl -X POST https://<DC-SPECIFIC-API-BASE-URL>/api/custom_connectors \
  -H "Authorization: Bearer <API-CLIENT-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "<connector_title>",
    "logo": "<connector_logo_base_64>",
    "description": "<connector_description>",
    "note": "<connector_note>",
    "code": "<connector_code>"
  }'

サンプルレスポンス

json

{
    "id": 3066,
    "name": "new_connector_1_connector_4771_1626869114",
    "title": "Acme Connector",
    "logo": "<base_64 encoded logo>",
    "latest_version": 6,
    "latest_version_note": "Latest version",
    "latest_released_version": 4,
    "latest_released_version_note": null,
    "latest_shared_version": 6,
    "latest_shared_version_note": "Latest version",
    "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"
        }
    ]
}

カスタムコネクターを更新

Update操作では、ワークスペース内のカスタムコネクターを更新できます。

PUT /api/custom_connectors/:id

URLパラメーター

名前	タイプ	説明
ID	Integer 必須	更新するカスタムコネクターのID。カスタムコネクターIDは、カスタムコネクター検索エンドポイントで確認できます。

サンプルリクエスト

shell

curl -X PUT https://<DC-SPECIFIC-API-BASE-URL>/api/custom_connectors/:id \
  -H "Authorization: Bearer <API-CLIENT-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "<connector_title>",
    "logo": "<connector_logo_base_64>",
    "description": "<connector_description>",
    "note": "<connector_note>",
    "code": "<connector_code>"
  }'

サンプルレスポンス

json

{
    "id": 3066,
    "name": "new_connector_1_connector_4771_1626869114",
    "title": "Acme Connector",
    "logo": "<base_64 encoded logo>",
    "latest_version": 6,
    "latest_version_note": "Latest version",
    "latest_released_version": 4,
    "latest_released_version_note": null,
    "latest_shared_version": 6,
    "latest_shared_version_note": "Latest version",
    "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"
        }
    ]
}

カスタムコネクターをリリース

Release操作では、カスタムコネクターの最新バージョンをリリースできます。新しいバージョンをリリースすると、今後のすべてのジョブで使用されます。

POST /api/custom_connectors/:id/release

URLパラメーター

名前	タイプ	説明
ID	Integer 必須	リリースするカスタムコネクターのID。カスタムコネクターIDは、カスタムコネクター検索エンドポイントで確認できます。

サンプルリクエスト

shell

curl -X POST https://<DC-SPECIFIC-API-BASE-URL>/api/custom_connectors/:id/release \
  -H "Authorization: Bearer <API-CLIENT-TOKEN>"

サンプルレスポンス

json


{
    "id": 3066,
    "name": "new_connector_1_connector_4771_1626869114",
    "title": "Acme Connector",
    "logo": "<base_64 encoded logo>",
    "latest_version": 6,
    "latest_version_note": "Latest version",
    "latest_released_version": 4,
    "latest_released_version_note": null,
    "latest_shared_version": 6,
    "latest_shared_version_note": "Latest version",
    "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"
        }
    ]
}

HTTPレスポンスコード

名前	説明	サンプル返信
`200`	成功	`{"message": "Connector released successfully"}`
`400`	不正なリクエスト	`{"message": "Fix code errors before releasing the connector"}`または`{"message": "Connector’s released version is already the latest version"}`

400エラーの例

構文の例

json

{ "errors" => [{ "code" => 400, "title" => "Line 2 has syntax errors. Please check Workato UI for further details." }] }

セマンティックの例

json

{ "errors" => [{ "code" => 400, "title" => "Expected string or lambda for 'description' in 'test_trigger' trigger but got Symbol." }] }

論理の例

json

{ "errors" => [{ "code" => 400, "title" => "The latest version of the custom connector is already released." }] }

Share操作では、カスタムコネクターの直近にリリースされたバージョンを共有できます。カスタムコネクターを共有すると、プライベートリンクまたはコミュニティライブラリからコネクターをインストールしたすべてのワークスペースに更新通知が届きます。

POST /api/custom_connectors/:id/share

名前	タイプ	説明
ID	Integer 必須	共有するカスタムコネクターのID。カスタムコネクターIDは、カスタムコネクター検索エンドポイントで確認できます。

shell

curl -X POST https://<DC-SPECIFIC-API-BASE-URL>/api/custom_connectors/:id/share \
  -H "Authorization: Bearer <API-CLIENT-TOKEN>"

json

{
    "id": 3066,
    "name": "new_connector_1_connector_4771_1626869114",
    "title": "Acme Connector",
    "logo": "<base_64 encoded logo>",
    "latest_version": 6,
    "latest_version_note": "Latest version",
    "latest_released_version": 4,
    "latest_released_version_note": null,
    "latest_shared_version": 6,
    "latest_shared_version_note": "Latest version",
    "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"
        }
    ]
}

名前	説明	サンプル返信
`200`	成功	`{"message": "Connector shared successfully"}`
`400`	不正なリクエスト	`{"message": "There is no released version to share"}`または`{"message": "Connector’s shared version is already the latest released version"}`

論理: 共有するリリース済みバージョンがない場合の例

json

{ "errors" => [{ "code" => 400, "title" => "Release the latest version of the code first" }] }

論理: 最新リリースバージョンがすでに共有されている場合の例

json

{ "errors" => [{ "code" => 400, "title" => "The latest version of the custom connector is already shared" }] }

Last updated:

カスタムコネクター ​

レート制限 ​

クイックリファレンス ​

JSONからスキーマを生成 ​

URLパラメーター ​

サンプルリクエスト ​

レスポンス ​

CSVからスキーマを生成 ​

URLパラメーター ​

サンプルリクエスト ​

レスポンス ​

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

ペイロード ​

サンプルリクエスト ​

サンプルレスポンス ​

カスタムコネクターコードを取得 ​

URLパラメーター ​

サンプルリクエスト ​

サンプルレスポンス ​

カスタムコネクターを作成 ​

ペイロード ​

サンプルリクエスト ​

サンプルレスポンス ​

カスタムコネクターを更新 ​

URLパラメーター ​

サンプルリクエスト ​

サンプルレスポンス ​

カスタムコネクターをリリース ​

URLパラメーター ​

サンプルリクエスト ​

サンプルレスポンス ​

HTTPレスポンスコード ​

400エラーの例 ​

カスタムコネクターを共有 ​

URLパラメーター ​

サンプルリクエスト ​

サンプルレスポンス ​

HTTPレスポンスコード ​

400エラーの例 ​

カスタムコネクター

レート制限

クイックリファレンス

JSONからスキーマを生成

URLパラメーター

サンプルリクエスト

レスポンス

CSVからスキーマを生成

URLパラメーター

サンプルリクエスト

レスポンス

カスタムコネクターを検索

ペイロード

サンプルリクエスト

サンプルレスポンス

カスタムコネクターコードを取得

URLパラメーター

サンプルリクエスト

サンプルレスポンス

カスタムコネクターを作成

ペイロード

サンプルリクエスト

サンプルレスポンス

カスタムコネクターを更新

URLパラメーター

サンプルリクエスト

サンプルレスポンス

カスタムコネクターをリリース

URLパラメーター

サンプルリクエスト

サンプルレスポンス

HTTPレスポンスコード

400エラーの例

カスタムコネクターを共有

URLパラメーター

サンプルリクエスト

サンプルレスポンス

HTTPレスポンスコード

400エラーの例