Hello Clever Developer Docs

Hello Clever の Cashback API では、即時キャッシュバックの特典を自社のプラットフォームやホワイトラベルの製品へ直接組み込めます。Merchant Portal（マーチャントポータル）でキャンペーンを管理する代わりに、API を呼び出してキャンペーンの設定を取得し、顧客のキャッシュバックアカウントを有効化し、キャッシュバックの配布と出金をプログラムから開始できます。

Cashback API を使う場面

Merchant Portal のキャンペーン

Hello Clever のストア向けにキャッシュバックキャンペーンをコードなしで作成・管理したい場合は Merchant Portal を使ってください。API の呼び出しは不要です。

Cashback API

独自のプラットフォームを構築する場合、Hello Clever のキャッシュバックをホワイトラベルで提供する場合、またはキャンペーンの配布とユーザー管理をプログラムからコントロールする必要がある場合は Cashback API を使ってください。

認証

Cashback API は app-id と secret-key を HTTP ヘッダーとして使用します。

curl https://api-merchant.helloclever.co/api/v2/cashbacks/campaigns \
  -H "app-id: your-app-id" \
  -H "secret-key: your-secret-key"

認証情報は Merchant Portal から取得します。連携キーを参照してください。

利用できるエンドポイント

リソース	説明
キャンペーン	キャンペーンの一覧、設定の取得、ユーザー一覧の取得
配布と出金	キャッシュバックアカウントの有効化、キャッシュバックの配布の開始、出金の開始

主な機能

キャンペーンの管理：すべてのキャッシュバックキャンペーンの一覧と、その詳細な設定（キャッシュバック率、段階、期間、上限）を取得します。
ユーザーのキャッシュバックアカウント：特定のユーザーがキャッシュバックの特典を受け取れるよう、そのアカウントを有効化します。
キャッシュバックの配布：対象となる取引の後に、ユーザーのアカウントへのキャッシュバックの配布を実行します。
キャッシュバックの出金：キャッシュバックの資金をユーザーの銀行口座へ出金する処理を開始します。
ユーザーの一覧：プラットフォーム上で有効なキャッシュバックアカウントを持つすべてのユーザーを取得します。

関連トピック

Hello Clever API の概要カード決済 API の概要 Merchant Portal の概要

⌘I