pier-cloud について
pier-cloudは、Pier Cloud APIを利用するためのスクリプトと再利用可能なPythonクライアントを提供します。認証後、コンテキスト、ワークスペース、ビュー、ワークスペースグループを一覧・取得できます。
主な機能
- 01認証情報によるJWT認証
- 02コンテキストとページ分割されたワークスペースの一覧
- 03ワークスペースとビューの詳細取得
- 04フィルターを使ったビューのデータ取得
- 05ワークスペースグループへのアクセス
活用シーン
- 01自動ページネーションで全ワークスペースを一覧
- 02ワークスペースビューから条件付きデータを取得
- 03長時間のセッション中にJWTを更新
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ fabricioctelles/ skills --skill pier-cloudインストール後、Claude Code で/pier-cloudを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
.env.examplereferences/REFERENCE.mdTROUBLESHOOTING.mdscripts/pier_cloud_client.pypier-cloud-auth.pypier-cloud-get-all-workspaces.pypier-cloud-get-view-data.pypier-cloud-get-view.pypier-cloud-get-workspace-group.pypier-cloud-get-workspace.pypier-cloud-list-contexts.pypier-cloud-list-views.pypier-cloud-list-workspace-groups.pypier-cloud-list-workspaces.pyREADME.md詳細
Pier Cloud API
前提条件
認証情報
スキルディレクトリにある .env ファイルを確認し、次の変数が設定されていることを確認してください。
PIERCLOUD_CLIENT_ID=your_client_id
PIERCLOUD_CLIENT_SECRET=your_client_secret
PIERCLOUD_TENANCY_ID=your_tenancy_id
.env ファイルが存在しない場合は、作業を進める前に Pier Cloud プラットフォームから認証情報を取得する必要があることをユーザーに伝えてください。.env ファイルがない状態で作業を進めないでください。
注:
PIERCLOUD_TENANCY_IDは、以前のPIERCLOUD_BUSINESS_IDと同等です。スクリプトではフォールバックとして両方を受け付けます。
Python の依存関係
pip install requests python-dotenv
基本設定
API では JWT 認証を使用します。必要な手順は次のとおりです。
client_idとclient_secretを指定してPOST /authで認証し、JWT トークンを取得します- すべてのリクエストにトークンを含めます:
Authorization: Bearer {token} - トークンの有効期限が切れたら更新します(デフォルトの有効期間:1 時間)
ベース URL:https://api.piercloud.io
ワークスペースグループは
/lighthouse/tenancies/{tenancy_id}/workspaces-groupsにあります(workspaces が複数形であることに注意してください)。
次を実行して接続を確認してください。
python scripts/pier-cloud-auth.py
利用可能なスクリプト
scripts/ にすぐに使用できるスクリプトがあります。詳しい手順については、scripts/README.md を参照してください。
| スクリプト | 説明 |
|---|---|
pier-cloud-auth.py | 認証して JWT トークンを取得 |
pier-cloud-list-contexts.py | 利用可能なコンテキストを一覧表示 |
pier-cloud-list-workspaces.py | ページネーションを使用してワークスペースを一覧表示 |
pier-cloud-get-workspace.py | 指定したワークスペースの詳細を取得 |
pier-cloud-get-all-workspaces.py | すべてのワークスペースを取得(自動ページネーション) |
pier-cloud-list-views.py | ワークスペースのビューを一覧表示 |
pier-cloud-get-view.py | 指定したビューの情報を取得 |
pier-cloud-get-view-data.py | フィルターを使ってビューのデータを取得 |
pier-cloud-list-workspace-groups.py | ワークスペースグループを一覧表示(/workspaces-groups) |
pier-cloud-get-workspace-group.py | ID でワークスペースグループを取得 |
pier_cloud_client.py | CLI と再利用可能なライブラリを備えた堅牢なクライアント |
ワークフロー
リクエストとレスポンスの例を含む詳しいワークフローについては、references/REFERENCE.md を参照してください。
- ワークフロー 1 — 認証とトークンの取得
- ワークフロー 2 — コンテキストの一覧表示
- ワークフロー 3 — ワークスペースの一覧表示
- ワークフロー 4 — ワークスペースの詳細を取得
- ワークフロー 5 — すべてのワークスペースを取得(自動ページネーション)
- ワークフロー 6 — 再試行とトークン更新に対応した堅牢なクライアント
- ワークフロー 9 — ワークスペースのビューを一覧表示
- ワークフロー 10 — ビューの情報を取得
- ワークフロー 11 — フィルターを使ってビューのデータを取得
- ワークフロー 12 — ワークスペースグループを一覧表示(
/workspaces-groups) - ワークフロー 13 — ワークスペースグループの詳細を取得
エンドポイントのリファレンス、パラメーター、レスポンス構造、cURL の例については、references/REFERENCE.md を参照してください。
エラーの診断(401、403、404、タイムアウト、レート制限)については、references/TROUBLESHOOTING.md を参照してください。
追加リソース
- API ドキュメント:https://docs.piercloud.com/api-docs-pier-cloud
- 公開ルート(英語):https://docs.piercloud.com/api-docs-pier-cloud/api-pier-cloud/public-routes-en-us
- Pier Cloud プラットフォーム:https://piercloud.com/en/
品質チェックリスト
-
PIERCLOUD_CLIENT_ID、PIERCLOUD_CLIENT_SECRET、PIERCLOUD_TENANCY_IDが設定された.envファイルがある - Python の依存関係がインストールされている(
requests、python-dotenv) - 認証に成功している(エラーなく JWT トークンを取得済み)
- 正しいエンドポイントを使用している(
/lighthouse/tenancies/{tenancy_id}/...、グループはworkspaces-groups) - 長時間のセッションでは、有効期限が切れる前にトークンを更新している
- ワークスペース ID/ビュー ID を直接使用する前に、一覧表示で確認している
- エラーを
references/TROUBLESHOOTING.mdに従って処理している