Embedded パートナー API ​

Workato の Embedded パートナープラットフォーム API を使用すれば、パートナーは、カスタマーアカウントやアセット (レシピやコネクションなど) をプログラムによって作成し、管理することができます。

認証 ​

API に対して認証を行うには、パートナーのメイン管理者アカウントの API キーとメールアドレス を使用します。

資格情報を取得するには、アカウント内の [Settings] > [API key] ページに移動します。

リクエストヘッダーまたはクエリーパラメータを使用して認証できます。

リクエストヘッダーを使用した認証 ​

リクエストヘッダーを使用して認証するには、X-USER-TOKEN の値として API キーを、X-USER-EMAIL の値としてメールアドレスを含めます。

curl  -X GET 'https://www.workato.com/api/managed_users/19029/properties?prefix=salesforce_sync.' \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \

クエリーパラメータを使用した認証 ​

クエリーパラメータを使用して認証するには、user_token の値として API キーを、user_email の値としてメールアドレスを含めます。

curl -X GET 'https://www.workato.com/api/managed_users/19029/connections?user_email=<EMAIL_ADDRESS>&user_token=<TOKEN>'

サポートされている形式 ​

API に送信するリクエストには、ヘッダーに Content-type: application/json を含める必要があります。

curl  -X GET 'https://www.workato.com/api/managed_users/19029/properties?prefix=salesforce_sync.' \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \

レスポンスは application/json; charset=utf-8 を使用してエンコードされます。

HTTP レスポンスコード ​

リソース ​

• コネクター
• カスタムコネクター
• コネクション
• ピックリスト
• フォルダー
• カスタマーアカウント
• レシピ
• レシピライフサイクル管理
• API プラットフォーム
• ロール
• アカウントプロパティ
• Lookup table

コネクター ​

カスタムコネクター ​

コネクション ​

ピックリスト ​

フォルダー ​

カスタマーアカウント ​

レシピ ​

レシピライフサイクル管理 ​

パッケージをエクスポートする API を探すには、Workato API のドキュメントを参照してください。

API プラットフォーム ​

ロール ​

アカウントプロパティ ​

Lookup table ​