WorkatoプラットフォームCLI
非推奨
WorkatoプラットフォームCLIは非推奨です。 Workatoでは、Workato Labsのwk CLIの使用を推奨しています。
WorkatoプラットフォームCLIは、Workato API向けの最新の型安全なコマンドラインインターフェースです。開発者がWorkatoレシピ、コネクション、プロジェクトを構築、検証、管理できるように設計されています。
プラットフォームCLIで使用できるAPIの詳細については、Workato Developer APIおよびEmbedded APIを参照してください。
機能の提供状況
プラットフォームCLIは、中国データセンターのワークスペースでは利用できません。 これは現地の規制要件を反映したものであり、当社のマルチテナントおよびVirtual Private Workato（VPW）サービスに適用されます。
機能
WorkatoプラットフォームCLIには、次の機能があります:
- プロジェクト管理: Workatoプロジェクトの作成、プッシュ、プル、管理
- レシピ操作: レシピの検証、開始、停止、管理
- コネクション管理: OAuthコネクションの作成と管理
- API統合: APIクライアント、コレクション、エンドポイントの管理
前提条件
WorkatoプラットフォームCLIには、次のものが必要です:
- Python 3.11以降
- 有効なWorkatoアカウントとAPIトークン
- Workato APIエンドポイントへのネットワークアクセス
Workatoでは、Gitなどのバージョン管理システムと併用してCLIを使用することをお勧めします。
認証
プラットフォームCLIを使用するには、必要なAPIエンドポイントへのアクセスを許可するクライアントロールを持つAPIクライアントを作成する必要があります。 APIクライアントを作成すると、CLIの設定に必要なAPIトークンが生成されます。
クライアントロールを作成する
プラットフォームCLIでは、プロジェクト、レシピ、コネクション、APIコレクションを管理するために、特定のAPIエンドポイントへのアクセスが必要です。
このAPIアクセスを定義するクライアントロールを作成するには、次の手順を実行します:
ワークスペース管理者＞APIクライアント＞クライアントロールに移動します。
クライアントロールを追加をクリックします。
クライアントロールを説明する名前を入力します。
プロジェクトタブで次を選択します:
- プロジェクトとフォルダ: すべて選択します。
- コネクション: すべて選択します。
- レシピ: すべて選択します。
- レシピバージョン: すべて選択します。
- レシピライフサイクルマネジメント: すべて選択します。
- マニフェストのエクスポート: すべて選択します。
ツールタブで次を選択します:
- コレクションとエンドポイント
- コレクションの一覧表示
- コレクションの作成
- コレクション内のエンドポイントの一覧表示
- エンドポイントの有効化
- エンドポイントの無効化
- Connector SDKs
- カスタムコネクタの一覧表示
- カスタムコネクタコードの取得（ワークスペースに1つ以上のカスタムコネクタがある場合にのみ必要）
- コネクタ
- コネクタの一覧表示
管理タブで次を選択します:
- ワークスペースの詳細: すべて選択します。
変更を保存をクリックします。
詳細な手順については、APIクライアントとロールの設定を参照してください。
APIクライアントを作成する
APIクライアントを作成し、作成したクライアントロールに関連付けるには、次の手順を実行します:
Workatoでワークスペース管理者＞APIクライアントに移動します。
APIクライアントを作成をクリックします。
APIクライアントの名前を入力します。
上記で作成したクライアントロールを選択します。 これにより、APIクライアントがクライアントロールで定義されたエンドポイントにアクセスできるようになります。
Environmentアクセスドロップダウンメニューを使用して、APIクライアントがワークスペース内でアクセスできるEnvironmentを指定します。 別のEnvironmentへのアクセスを許可するには、別のAPIクライアントを作成する必要があります。
プロジェクトアクセスドロップダウンメニューを使用して、APIクライアントがワークスペース内のすべてのプロジェクトにアクセスできるか、特定のプロジェクトにのみアクセスできるかを指定します。
任意の許可IPを入力します。
クライアントを作成をクリックします。
APIトークンをコピーして保存します。 プラットフォームCLIを設定するときに、このトークンが必要になります。
プラットフォームCLIをインストールする
プラットフォームCLIをインストールするには、次の手順を実行します:
pip install workato-platform-cliを実行してCLIをインストールします。
workato --versionを実行して、インストールが成功したことを確認します。
プラットフォームCLIを設定する
workato initを実行して、CLI設定を初期化します。 CLIから、ワークスペースルートを含むウェルカムメッセージが返されます。
プロファイルを設定します。 新しいプロファイルを使用するにはプロファイル名を入力し、デフォルトプロファイルを使用するにはEnterキーを押します。
例:
📋 Step 1: Configure profile
Enter profile name [default]:次のオプションからWorkatoリージョンを選択します:
[?] Select your Workato region:
US Data Center (https://www.workato.com)
EU Data Center (https://app.eu.workato.com)
JP Data Center (https://app.jp.workato.com)
SG Data Center (https://app.sg.workato.com)
AU Data Center (https://app.au.workato.com)
IL Data Center (https://app.il.workato.com)
KR Data Center (https://app.kr.workato.com)
Developer Sandbox (https://app.trial.workato.com)
> Custom URLAPIトークンを入力します。 APIトークンはwrkで始まり、Environmentのタイプに一致する末尾を持ちます。 たとえば、プロダクションEnvironmentの場合はwrkprod-です。
例:
🔐 Enter your API token
Enter your Workato API token: wrkprod-**************
✅ Authenticated as: User Name
✅ Profile: defaultプロジェクトをディレクトリに保存
Workatoでは、整理された状態を維持するために、プロジェクトを保存するディレクトリを作成することをお勧めします。
プラットフォームCLIで使用する予定のプロジェクトを選択します。 操作する予定のレシピまたはコネクションを含むプロジェクトを使用します。
例:
📁 Step 2: Setup project
[?] Select a project:
Create new project
Home (ID: 75422)
Development projects (ID: 61943)
Sales automation project (ID: 61940)
> Customer Onboarding (ID: 60715)プロジェクトフォルダが空でない場合でも初期化を続行するには、yを入力します。 これにより、既存のプロジェクトに設定ファイルまたはその他のセットアップファイルが追加されます。 初期化を停止し、プロジェクトフォルダへの変更を防ぐには、Nを入力します。
⚠️ Directory '/Users/workato/Customer Onboarding' is not empty.
Proceed with initialization? This may overwrite or delete files. [y/N]: y初期化が成功したかどうかを示すメッセージが表示されます。例:
✅ Successfully pulled project changes (+324 -0)
🎉 Project setup complete!workato workspaceを実行して、ワークスペースが正常に設定されていることを確認します。
最終更新日: