loops-api

Loops API と SDK のスキル

このスキルは、アプリケーションコードから Loops を実装するワークフローを支援します。バックエンド連携、正確なリクエストの案内、SDK と HTTP の選択に利用してください。

使用するタイミング

ユーザーが次のことを行う場合に、このスキルを使用してください。

• Loops をアプリ、バックエンド、Webhook、自動化に統合する
• 公式 SDK と生の HTTP のどちらを使うか判断する
• コンタクト、コンタクトプロパティ、メーリングリスト、イベント、トランザクションメールを管理する
• トランザクションメールを送信する、または API 経由でトランザクションメールのテンプレートを作成、編集、公開する
• コンタクトの抑制ステータスや削除を管理する
• オーディエンスターゲティング（メーリングリスト、セグメント、フィルター）、グループ、スケジュールを指定してキャンペーンの下書きを作成する
• キャンペーンやトランザクションメールをグループに整理する
• キャンペーンやワークフローのターゲティング用に、オーディエンスセグメントを一覧表示または作成する
• メールメッセージのコンテンツ（件名、送信者、CC/BCC、形式、フォールバック、LMX）を更新し、プレビューを送信して Guardian チェックを実行する
• LMX ペイロードの構築に使用するテーマやコンポーネントを一覧表示、作成、更新、取得する
• メールコンテンツ用の画像をアップロードする
• ワークフローとワークフローノード（メーリングリストの変更、分岐、リルート、キュー内のコンタクト処理を含む）を作成、更新、調査、削除する
• ワークフローのイベントトリガー用のイベントパターンを一覧表示する
• Loops の受信 Webhook（コンタクト、メール送信、エンゲージメントイベント）を受信して検証する
• 認証情報を検証する、またはコードから Loops リクエストの動作をトラブルシューティングする

このスキルは、実装と運用での使用を対象としており、広範なメール戦略や到達性のレビューを対象としていません。

作業スタイル

このスキルが有効な場合：

1. まず適切なインターフェース（SDK または生の HTTP）を選択します。
2. その言語の公式 SDK がある場合は、アプリケーションコードでは公式 SDK を優先します。
3. SDK がない場合、またはユーザーが正確なペイロードを制御する必要がある場合に限り、生の HTTP を優先します。
4. Loops リクエストはサーバー側で実行します。
5. 詳細が重要な場合は、公式ドキュメントまたは OpenAPI 仕様で正確な動作を確認します。
6. LMX のメールデザインやブランド関連の作業では、references/http-api.md のテーマ／コンポーネントエンドポイントを使用します。LMX のデザインポリシーは loops-lmx スキルにあります。
7. タスクの主な内容が Loops CLI のインストール、認証、シェルでの使用、コマンドのヘルプの場合は、別途 loops-cli スキルを使用します。

公式リファレンス：

• ドキュメント：https://loops.so/docs
• API リファレンス：https://loops.so/docs/api-reference/intro
• キャンペーンの例：https://loops.so/docs/api-reference/examples/campaigns
• JavaScript SDK：https://loops.so/docs/sdks/javascript
• Webhook：https://loops.so/docs/webhooks
• OpenAPI 仕様：https://app.loops.so/openapi.json

インターフェースの選択

• SDK または HTTP API：
  • アプリケーションコード
  • バックエンドサービス
  • Webhook ハンドラー
  • 繰り返し利用する連携 references/http-api.md を参照してください。

アプリケーションコードを書くのではなく、ターミナルから作業する場合は、loops-cli スキルを使用してください。

カテゴリー別の案内

• 認証、ベース URL、レート制限、コンタクト、抑制、プロパティ、リスト、イベント、アップロード、Loops の受信 Webhook、SDK の例、HTTP エラー： references/http-api.md を参照してください。
• キャンペーン、キャンペーングループ、トランザクショングループ、オーディエンスセグメント、ワークフロー、ワークフローノード、イベントパターン、トランザクションメール、メールメッセージ、テーマ、コンポーネント、リビジョンを安全に扱う更新： references/http-api.md を参照してください。LMX マークアップ自体については、loops-lmx スキルも使用してください。

出力チェックリスト

ユーザーに次の内容を提示できるようにします。

• タスクに適した API インターフェースの選択
• 正確なペイロード形式または SDK の使用方法
• 動作に影響する Loops 固有の注意点
• 小規模なテストリクエストや API キーの確認など、次の検証手順