本文へ移動
mini.casa
開発者向け

わかる手順で、ポートフォリオを動かす

インポート、ドライラン、正確な計画の承認を経て、一時停止、再試行、ロールバックができるバッチで実行します。

一括処理は、人が正確な計画を確認して承認するまで、何も変わらないように作られています。接続にはportfolios:read、portfolios:write、portfolios:execute、approvals:requestと、予定する操作に応じたcasaのスコープが必要です。

一覧をインポートする

POST /workspaces/{id}/portfoliosは、ヘッダーitem_key,domain,source_url,world_handle,template_id,content_languageを持つCSV、または同じフィールドのitems[]を、preserve_existing_mx: true付きで最大1000行受け取ります。行ごとに個別に検証します。ドメインは正規化し、重複や安全でないURLはブロックし、ソースで見つけた文章は信頼できないデータとして保存します。この時点では、ほかに何も起きません。

ドライランの計画を作り、読む

POST /workspaces/{id}/bulk-plansは、希望する操作(create_draft、apply_import、set_dna、publish、ドメインの手順)、予算上限、rollout_batchesを受け取ります。たとえば[5, 95]なら、最初に五件で試し、それから残りを実行します。変更不能なマニフェストと、そのplan_hashが返ります。GET /bulk-plans/{plan_id}で読み、項目ごとの全手順、変更予定の内容、ロールバック方法を確認してください。DNSの手順はウェブサイトのレコードだけに触れ、メールのレコードはそのまま保ちます。計画は24時間で期限切れになります。

オーナーに承認を求める

POST /workspaces/{id}/approvalsは、正確なplan_hash、上限、有効期限を結び付け、approval_urlを返します。決定できるのはオーナーだけで、ブラウザーで再度サインインし、表示されたハッシュを確認して行います。計画を変えた場合、承認は決して使い回せません。トークンによる承認もできません。

実行し、見守り、調整する

  • POST /bulk-plans/{plan_id}/executeにplan_hashとapproval_idを渡すと、その承認で許された一回の実行が始まります。最初の試験バッチが先に動き、continueで残りを始めます。
  • GET /bulk-runs/{run_id}、またはjob.updatedとjob.item.updatedのWebhookで見守ります。
  • pause、resume、cancel、retry(完了した手順は繰り返しません)で実行を調整します。rollbackは、その後変更されていない限り、この実行が書き込んだものを元に戻します。

登録、送信済みメッセージ、すでに進んだDNSの反映は元に戻せず、ロールバック済みと報告することもありません。トークンを失効させると、次の手順から新しい処理が止まります。

現在利用できるもの

インポート、検証、ドライランの計画、承認は、どの環境でも動作します。開発環境とテスト環境では、シミュレーション用のドメイン、DNS、証明書プロバイダーに対して、実行を最初から最後まで動かせます。本番環境では、実際のプロバイダー接続が整うまで無効です。GET /capabilitiesでは、これをbulk.executeとして報告します。