Product UpdatesStatus PageAutomation Institute
日本語
Workato Embedded API
リソース

# Workato API - コネクション

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

このガイド内のエンドポイントは、Embedded ベンダー API であり、oem_vendor 権限が必要です。使用中のアカウントでこの権限を有効にするには、Workato の担当者までお問い合わせください。

コネクション リソースを使用すれば、Embedded カスタマーアカウントをプログラムで管理することができます。

# クイックリファレンス

タイプ リソース 説明
GET /api/managed_users/:managed_user_id/connections Embedded ユーザーのアカウント内のすべてのコネクションを返します。
POST /api/managed_users/:id/connections Embedded パートナーがカスタマーアカウント内にシェルコネクションを追加できるようにします。
PUT /api/managed_users/:id/connections/:connection_id カスタマーアカウント内のコネクションを更新します。
POST /api/managed_users/:id/connections/:connection_id/disconnect カスタマーアカウント内のコネクションを切断します。
DELETE /api/managed_users/:id/connections/:connection_id カスタマーアカウント内の切断されたコネクションを削除します。

# コネクションの列挙

Embedded カスタマーアカウントのすべてのコネクションと関連するデータを返します。

GET /api/managed_users/:managed_user_id/connections

# URL パラメータ

名前 型 説明
managed_user_id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例: EA2300)。結果として返される ID は URL エンコードされます。

# ペイロード

結果を絞り込むために次のプロパティをリクエスト本文に含めます。

名前 種類 説明
provider string
任意		 コネクションのアプリケーションタイプ。例 : salesforce
folder_id string
任意		 コネクションを含むプロジェクトまたはフォルダーの ID。
parent_id string
任意		 親コネクションの ID。親コネクションは同じ provider 型である必要があります。詳細については、こちらを参照してください。
external_id string
任意		 コネクションに割り当てられた外部 ID。通常は、コネクションを所有するユーザーに付与されます。

# サンプルリクエスト

curl  -X GET https://www.workato.com/api/managed_users/98178/connections \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# レスポンス

{
 "result": [
   {
     "id": 36,
     "name": "ACME Production Salesforce connection",
     "provider": "salesforce",
     "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": "U12904",
     "folder_id": 4515,
     "parent_id": 22316
   },
   {
     "id": 37,
     "name": "ACME google sheet account",
     "provider": "google_sheets",
     "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": "U12904",
     "folder_id": 4515,
     "parent_id": 22317
   }
 ]
}

# コネクションの作成

カスタマーアカウント内にコネクションを作成します。このエンドポイントは、カスタマーアカウント内で以下の動作をサポートします。

  • シェルコネクションの追加
  • コネクションの追加と認証
POST /api/managed_users/:managed_user_id/connections

# URL パラメータ

名前 型 説明
managed_user_id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例: EA2300)。結果として返される ID は URL エンコードされます。

# ペイロード

名前 型 説明
name string
任意		 コネクションの名前。例 : Prod Salesforce connection
provider string
任意		 コネクションのアプリケーションタイプ。例 : salesforce
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/managed_users/98178/connection \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "jira_connection",
            "provider": "jira",
            "folder_id": 1892,
            "external_id": "128904"
          }'

# 資格情報を含むコネクション

これにより、コネクションが作成され、認証されます。

curl  -X POST https://www.workato.com/api/managed_users/98178/connection \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "jira_connection",
            "provider": "jira",
            "input": {
              "host_name": "acme.atlassian.net",
              "api_token_auth": "true",
              "email": "smith@acme.com",
              "apitoken": "XXXXXXXX"
            }
          }'

# レスポンス

{
   "id":36,
   "name":"jira_connection",
   "provider":"jira",
   "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":"U12904",
   "folder_id":4515,
   "parent_id":22318
}

# コネクションの更新

カスタマーアカウント内にコネクションを更新します。

PUT /api/managed_users/:managed_user_id/connections/:connection_id

# URL パラメータ

名前 型 説明
managed_user_id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例: EA2300)。結果として返される ID は URL エンコードされます。
connection_id string
必須		 コネクションの ID。

# ペイロード

名前 型 説明
name string
任意		 コネクションの名前。例 : Prod Salesforce connection
parent_id string
任意		 親コネクションの ID。詳細については、こちらを参照してください。
folder_id string
任意		 コネクションを含むプロジェクトまたはフォルダーの ID。
external_id string
任意		 コネクションに割り当てられた外部 ID。この値は、アプリケーションの別のコネクション内のレコードを参照できます。
input object
任意		 コネクションパラメータ。

プロバイダーとコネクションパラメータのリストについては、プラットフォーム API コネクションパラメータリファレンスを参照してください。

# サンプルリクエスト

curl  -X PUT https://www.workato.com/api/managed_users/98178/connections/1678 \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -d  '{
            "name": "jira_connection_latest",
            "folder_id": 28940,
            "input": {
              "host_name": "acme.atlassian.net",
              "api_token_auth": "true",
              "email": "smith@acme.com",
              "apitoken": "XXXXXXXX"
            }
          }'

# レスポンス

{
   "id":36,
   "name":"jira_connection",
   "provider":"jira",
   "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":"U12904",
   "folder_id":4515,
   "parent_id":22318
}

# コネクションの切断

カスタマーアカウント内のアクティブなコネクションを切断します。コネクションがすでに切断されている場合は、アクションは実行されません。

POST /api/managed_users/:managed_user_id/connections/:connection_id/disconnect

# URL パラメータ

名前 型 説明
managed_user_id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例: EA2300)。結果として返される ID は URL エンコードされます。
connection_id string
必須		 コネクションの ID。
force boolean
任意		 アクティブなレシピによって使用されているアクティブなコネクションを強制的に切断するには、値が true である必要があります。デフォルトで false に設定されます。

# ペイロード

ペイロードは予期されません。

# サンプルリクエスト

curl  -X POST https://www.workato.com/api/managed_users/98178/connections/1678/disconnect?force=true \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# レスポンス

  • アクティブなコネクションを正常に切断したか、コネクションはすでに切断されていました。
{
   "result": {
    "success": true,
    "status": "disconnected"
   }
}
  • 指定したコネクション ID が存在しません。
{
   "message": "Not found"
}

# コネクションの削除

カスタマーアカウント内の切断されたコネクションを削除します。コネクションがアクティブであるか、アクティブなレシピによって使用されている場合、この API リクエストは失敗します。

DELETE /api/managed_users/:managed_user_id/connections/:connection_id

# URL パラメータ

名前 型 説明
managed_user_id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例: EA2300)。結果として返される ID は URL エンコードされます。
connection_id string
必須		 コネクションの ID。

# サンプルリクエスト

curl  -X DELETE https://www.workato.com/api/managed_users/98178/connections/1678 \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# レスポンス

  • アクティブなコネクションを正常に切断したか、コネクションはすでに切断されていました。
{
   "result": {
    "success": true,
    "status": "deleted"
   }
}
  • 指定されたコネクションがアクティブです。
{
   "success": false,
   "status": "rejected",
   "message": "You can't delete a an active connection"
}
  • 指定されたコネクションはアクティブなレシピで使用されています。
{
   "success": false,
   "status": "rejected",
   "message": "You can't delete a connection used by active recipes"
}
  • 指定したコネクション ID が存在しません。
{
   "message": "Not found"
}
← トークン/シークレットの更新
コネクションパラメータの参照 →


Last updated: 2024/1/12 16:26:53

On this page