Connector SDK

以下のエンドポイントを使用すると、サンプルのJSONおよびCSVドキュメントからWorkatoスキーマを生成することができます。これらのエンドポイントは、スキーマ生成コマンドのSDK CLIツールでも使用されます。

クイックリファレンス

カスタムコネクタリソースには、次のエンドポイントが含まれています：

タイプ	リソース	説明
GET	/api/custom_connectors	カスタムコネクタを取得します。
POST	/api/sdk/generate_schema/json	文字列化されたJSONサンプルからWorkatoスキーマを生成します。
POST	/api/sdk/generate_schema/csv	文字列化されたCSVサンプルからWorkatoスキーマを生成します。

---

カスタムコネクタの検索

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

GET /api/custom_connectors

URLパラメータ

名前	タイプ	説明
title	string オプション	タイトルでコネクタを検索します。部分一致が返されます。
oem_shared	boolean オプション	OEMマスターアカウントから共有されているコネクタを検索します。

サンプルリクエスト

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

レスポンス

{
    "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"
                }
            ]
        }
    ]
}

---

JSONからスキーマを生成

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

POST /api/sdk/generate_schema/json

URLパラメータ

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

サンプルリクエスト

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

レスポンス

[
    {
        "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のいずれかである必要があります。

サンプルリクエスト

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

レスポンス

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

---