Orchestorのデータを、社内レポートや既存の業務システムから利用します。HTTP APIを通じて、対象ワークスペースを指定した取得処理を組み立てられます。画面での確認を定型処理へ移すときは、まず一つの取得を検証し、認証・対象・エラー処理を揃えます。
- HTTPで既存のシステムと連携
- APIキーとワークスペースを明示
- エラーの種類に合わせて処理を設計
最初のリクエストを組み立てる
APIキーを Bearer 認証で渡し、対象のワークスペースを指定します。次はブランド一覧を取得する例です。環境変数には、自分の環境で管理する値を設定します。
curl https://api.orchestor.io/v1/brands \
-H "Authorization: Bearer $ORCHESTOR_API_KEY" \
-H "X-Workspace-ID: $ORCHESTOR_WORKSPACE_ID"
ワークスペースIDは、APIキーの対象と一致させます。APIキーの値を共有用のコードやレポートに直接書かないでください。
取得から定型処理へ
- 利用したいデータのエンドポイントをドキュメントで確認します。
- 一つのワークスペースで、リクエストとレスポンスを検証します。
- 期間やフィルターを、比較したい画面の条件に揃えます。
- 必要な項目を社内レポートの形式へ変換します。
- エラー時の記録と再試行条件を決めます。
自動化の前に、一回の取得結果が期待する対象かを確認すると、別のワークスペースや条件のデータを継続的に集計する誤りを防げます。
エラーに応じて次の操作を変える
| 応答 | 最初に確認すること |
|---|---|
| 400 | 入力値やリクエスト形式 |
| 401 | APIキーと認証ヘッダー |
| 403 | 対象ワークスペースとアクセス権 |
| 404 | リソースの識別子と存在 |
| 429 | Retry-Afterと再試行の間隔 |
| 5xx | サービス側の状態と操作の再試行可否 |
認証や入力の問題は、同じリクエストを繰り返しても解決しません。更新処理を再試行する場合は、重複した操作にならないかも確認します。
API・CLI・MCPを使い分ける
アプリケーションからHTTPで直接組み込む場合はAPI、ターミナルからの調査やスクリプトにはCLI、AIクライアントからの利用にはMCPが入口になります。
どの入口でも、取得対象とアクセス権の確認は必要です。利用できるエンドポイントや入力形式の詳細は、下のドキュメントで確認してください。