Connections

以下のエンドポイントを使用して接続を管理します。

クイックリファレンス

タイプ	リソース	説明
GET	/api/connections	すべての接続と関連データを返します。
POST	/api/connections	接続を作成します。

接続の一覧

認証されたWorkatoユーザーのすべての接続と関連データを返します。

GET /api/connections

URLパラメータ

名前	タイプ	説明
folder_id	string オプション	接続のフォルダID。
parent_id	string オプション	接続の親ID。接続は同じプロバイダである必要があります。
external_id	string オプション	通常、接続を所有するユーザーに割り当てられる外部識別子。
include_runtime_connections	string オプション	"true"が指定されると、すべてのランタイムユーザー接続も返されます。

サンプルリクエスト

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

レスポンス

[
  {
    "application": "salesforce",
    "id": 36,
    "name": "ACME Production Salesforce connection",
    "description": null,
    "authorized_at": "2015-05-26T22:53:52.528Z",
    "authorization_status": "success",
    "authorization_error": null,
    "created_at": "2015-05-26T22:53:52.532Z",
    "updated_at": "2015-05-26T22:53:52.532Z",
    "external_id": null,
    "folder_id": 4515,
    "parent_id": null
  },
  {
      "application": "google_sheets",
      "id": 37,
      "name": "ACME google sheet account",
      "description": null,
      "authorized_at": "2015-05-26T22:53:52.528Z",
      "authorization_status": "success",
      "authorization_error": null,
      "created_at": "2015-05-26T22:53:52.532Z",
      "updated_at": "2015-05-26T22:53:52.532Z",
      "external_id": null,
      "folder_id": 4515,
      "parent_id": null
  }
]

接続の作成

新しい接続を作成します。このエンドポイントでは、次のアクションがサポートされています。

• シェル接続の作成、または
• 接続の作成と認証

機能の互換性：OAuthタイプの接続

このエンドポイントは、OAuthタイプの接続の作成と認証をサポートしていません。ただし、OAuth接続のシェル接続を作成するためにこのエンドポイントを使用できます。

POST /api/connections

ペイロード

以下のプロパティをリクエストボディに含めて結果をフィルタリングします。

名前	タイプ	説明
name	string オプション	接続の名前。例：Prod JIRA connection
provider	string オプション	接続のアプリケーションタイプ。例：jira
parent_id	string オプション	親接続のID。親接続は同じproviderタイプである必要があります。詳細を見る。
folder_id	string オプション	接続を含むプロジェクトまたはフォルダのID。
external_id	string オプション	接続に割り当てられた外部ID。通常、接続を所有するユーザーに与えられます。
input	Object オプション	接続パラメータ。 プロバイダと接続パラメータのリストについては、プラットフォームAPI接続パラメータリファレンスを参照してください。

サンプルリクエスト

• シェル接続
• 資格情報を持つ接続

シェル接続リクエスト

これにより、Disconnected状態の接続が作成されます。

curl  -X POST https://www.workato.com/api/connections \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "Prod JIRA connection",
            "provider": "jira",
            "folder_id": 1892,
          }'

資格情報を使用した接続

これにより、接続が作成され、認証されます。

curl  -X POST https://www.workato.com/api/connections \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "Prod JIRA connection",
            "provider": "jira",
            "folder_id": 1892,
            "input": {
              "host_name": "acme.atlassian.net",
              "auth_type": "api_token",
              "email": "smith@acme.com",
              "apitoken": "XXXXXXXX"
            }
          }'

レスポンス

{
   "id":36,
   "name":"Prod JIRA connection",
   "provider":"jira",
   "authorized_at":"2023-01-26T22:53:52.528Z",
   "authorization_status":"success",
   "authorization_error":null,
   "created_at":"2023-01-26T22:53:52.532Z",
   "updated_at":"2023-01-26T22:53:52.532Z",
   "external_id":null
   "folder_id":1892,
   "parent_id":null
}