導入の流れ
AnyCampaign の導入からキャンペーン実施までのステップを説明します。
導入ステップ概要
STEP 1: 契約・APIキーの取得
↓
STEP 2: 商品の登録と商品バリアントIDの確認
↓
STEP 3: テスト注文でAPI連携を確認
↓
STEP 4: 本番運用・キャンペーン開始
STEP 1: 契約・APIキーの取得
AnyReachの担当者と利用契約を締結します。契約後、Campaign APIを利用するための認証情報が発行されます。
発行される認証情報:
- x-anycampaign-key: APIキー(秘密情報として安全に管理してください)
- x-anycampaign-store-id: ストアID
これらをリクエストヘッダーに付与することでCampaign APIにアクセスできます。
STEP 2: 商品の登録と商品バリアントIDの確認
キャンペーンでギフトとして提供したい商品をAnyCampaignに登録します。登録後、商品ごとに一意の商品バリアントIDが発行されます。
商品バリアントIDの確認方法:
Campaign APIの商品検索エンドポイントを使って、利用可能な商品とそのIDを確認できます。
POST https://api.anycampaign.jp/v1/product_variants/search
取得した商品バリアントIDをキャンペーン管理システム側で保持しておくことで、注文作成時にスムーズに指定できます。
STEP 3: テスト注文でAPI連携を確認
本番稼働前にテスト注文を作成してフローを確認します。
テスト注文の作成:
POST https://api.anycampaign.jp/v1/orders
リクエスト例:
{
"productVariantIds": ["商品バリアントID"],
"senderEmail": "test@example.com",
"senderName": "テスト企業",
"message": "テストメッセージです。"
}
レスポンスで受け取ったrecipientUrlにアクセスし、受取フロー(商品選択→配送先入力)が正常に動作することを確認してください。
確認項目:
- APIコールでギフト注文が作成できるか
- recipientUrlが返却されるか
- 受取画面で配送先を入力できるか
- 受取完了後にメールが届くか
- Shopify利用時は下書き注文が作成されるか
STEP 4: 本番運用・キャンペーン開始
テストが完了したら本番環境でキャンペーンを開始します。
キャンペーン実施の流れ:
- 社内システムからCampaign APIを呼び出してギフト注文を作成
- 返却された受取URLをキャンペーン参加者(メール・SNS等)に配布
- 参加者が受取URLにアクセスし、商品を選択・配送先を入力
- 受取完了後、配送手配を実施
複数の参加者に配布する場合は、ループ処理でAPIを繰り返し呼び出して受取URLを一括生成できます。
API リファレンス
詳細なAPIの仕様については、AnyReachの担当者にお問い合わせください。Campaign APIへのアクセスに必要な情報はすべてAnyReachから提供されます。