スタンプ作成API

スタンプ作成APIは、顧客に新しいスタンプをプログラムから発行できる機能です。

カードIDXと有効期限を指定すると、対象のスタンプカードにスタンプが追加されます。ユーザー情報やメモもあわせて保存でき、顧客ごとのスタンプ履歴を整理して管理できます。
カードIDXはダッシュボードの「スタンプカード」ページで確認できます。

このAPIはパーソナルプラン以上で利用できます。

POST

/api/stamp/v1/create 

{
    "cardIdx": 123,  // You can check the IDX value on the card management page of the dashboard.
    "domain": "https://vvd.bz",
    "strtYmd": "2025-01-01",
    "endYmd": "2025-12-31",
    "activeYn": "Y",
    "memo": "New Member Registration, IP: 211.111.222.33",
    "userId": "att78z",
    "userNm": "Brown Smith",
    "userPhnno": "+1 123-4567-8900",
    "userEml": "test@gmail.com",
    "userEtc1": "Gold rating",
    "userEtc2": ""
}

Request Parameters

cardIdx integer required
カードIDX。
カードIDXはダッシュボードの「スタンプカード」ページで確認できます。
domain string
Default:https://vvd.bz
スタンプドメイン。
値が空の場合は、デフォルトドメインとして保存されます。
プレミアムプラン以上では、「リンクドメイン管理」で登録したカスタムドメインを指定できます。
strtYmd date required
スタンプの有効開始日。例: 2025-01-01
endYmd date required
スタンプの有効期限日。例: 2025-12-31
有効期限は本日から最長5年まで設定できます。
activeYn string
Default:Y
Enum:
YN
スタンプの有効状態。
無効化されている場合、顧客はスタンプを利用できません。
memo string
内部参照用メモ。
userId string
ユーザーID。
スタンプ発行対象者の管理に使用します。
通常は、ウェブサイト会員のログインIDを入力します。
設定されていない場合、システムによって自動的にユーザーIDが生成されます。
userNm string
ユーザー名。内部管理用。
userPhnno string
ユーザー連絡先。内部管理用。
userEml string
ユーザーのメールアドレス。内部管理用。
userEtc1 string
追加の内部管理用フィールド。
userEtc2 string
追加の内部管理用フィールド。 
{
    "code": 0,
    "message": "",
    "result": 1347
}

Response Parameters

code integer
応答コード: 0 = 成功、それ以外の値 = エラー
message string
応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
result integer
レスポンス値です。 生成されたスタンプIDXが返されます。
例：1347

このAPIを利用する場面

スタンプ型キャンペーンやリワードシステムの構築に使用します。

  • 来店回数に応じたリワードキャンペーン
  • 店舗でのスタンプ収集プログラム
  • ユーザー行動の認証システム
  • 特定アクション（購入・参加など）の記録

ユーザーの行動を記録し、リワードへとつなげる用途に最適です。

スタンプカードとスタンプの関係

スタンプカードはキャンペーンのルールとデザインを定義し、スタンプはユーザーに付与される実際の単位です。

作成APIを呼び出す際に cardIdx を指定し、どのカードにスタンプを付与するかを決定します。

カードIDXはダッシュボードで確認できます。カードごとに条件やリワードが異なるため、正しいカードを選択することが重要です。

スタンプ生成の仕組みと構成要素

スタンプは単なるデータではなく、ユーザー行動を記録する単位です。

主な構成要素:

  • カード識別子（cardIdx）: スタンプが属するカードID
  • 有効期間（strtYmd、endYmd）: スタンプの有効期間
  • ステータス（activeYn）: 利用可能かどうかを示す状態
  • ユーザー情報（userId、userNm、userEmail など）: 対象ユーザー
  • 追加情報（memo、userEtc1、userEtc2）: カスタムデータ

これにより、ユーザー行動を個別に追跡・管理できます。

ユーザー情報の連携

userId はスタンプ付与対象の識別と管理に使用されます。

通常は自社の会員IDを指定します。未指定の場合はシステムによって自動生成されます。

userNm、userPhnno、userEml などを設定することで、連絡先情報を保持し、ダッシュボード上でユーザーごとのスタンプ状況を管理できます。

活用例

  • 新規登録時のウェルカムスタンプ: 会員登録完了時にAPIを呼び出し、自動でスタンプを付与
  • 購入連動の自動付与: 決済完了時にスタンプ生成APIを呼び出し、購入回数に応じて付与
  • 期間限定キャンペーン: strtYmd・endYmd を使用して有効期間を限定したスタンプを発行
  • イベント参加履歴の管理: イベント参加時にスタンプを付与し、履歴を記録
  • リワードキャンペーン運用: 累計スタンプ数に応じてクーポンや特典を付与

クーポンAPIとの違い

クーポンAPIとスタンプAPIはどちらもマーケティングに活用されますが、目的と使い方は明確に異なります。

クーポンAPIは割引によって即時購入を促すコンバージョン重視のツールです。
一方、スタンプAPIはユーザー行動を記録し、継続的な利用を促すリテンション重視のツールです。

1. 目的

  • クーポンAPI → 割引提供 → 購入促進（Conversion）
  • スタンプAPI → 行動記録 → 再訪促進（Retention）

クーポンは短期的な売上向上に効果的であり、スタンプは長期的な利用促進に適しています。

2. 利用タイミング

  • クーポン → 決済前または決済時に使用
  • スタンプ → 訪問や参加などの行動時に付与

クーポンは「今すぐ購入させる仕組み」、スタンプは「次の行動を促す仕組み」です。

3. データ構造

クーポンは単発イベント型です。

  • 単回または回数制限あり
  • 割引額・割引率が中心
  • 使用時に即時消費または状態更新

スタンプは累積型です。

  • 繰り返し付与可能
  • ユーザー単位で累積管理
  • 条件達成時に報酬を付与

つまり、クーポンは 単発トリガー、スタンプは 累積データ です。

4. マーケティング戦略

クーポン戦略:

  • 新規ユーザー獲得
  • コンバージョン率向上
  • 特定商品の販売促進

スタンプ戦略:

  • 再訪促進
  • 顧客ロイヤルティ向上
  • 長期キャンペーン運用

5. 併用パターン

実際のサービスでは、両APIを組み合わせて利用するケースが一般的です。

例:

  • スタンプを蓄積（例: 来店10回）
  • 条件達成でクーポンを自動発行
  • クーポン利用で購入を促進

この構成により、 参加 → 継続 → 購入 を一連の流れとして設計できます。

利用時の注意点

  • cardIdx には有効なカードIDを必ず指定してください
  • 同一ユーザーへの重複付与ルールを事前に定義してください
  • 有効期間の設定ミスはキャンペーン運用に影響します