プログラムを運用する
API・Webhook
自社のシステムやお使いの他のアプリから、ロイヤルティプログラムを読み取り・更新できます。モバイルアプリで残高を表示したり、レビューにポイントを付与したり、会員が新しいランクに達したときに処理を行ったりできます。
できること
- ポイント、履歴、特典を表示し、特典の交換もできるモバイルアプリやヘッドレスストア。
- 他のアプリからのポイント付与:レビュー、クイズ、ストア内のイベント、自社の管理システムなど。
- 残高やランクをメール、ヘルプデスク、CRMツールに同期。
APIキーを作成する
- アプリのメニューからAPI・Webhookを開きます。
- APIキーを作成で、使う場所がわかる名前を付けます(例:「モバイルアプリ」や連携アプリの名前)。
- アクセスで必要なものだけを選び、キーを作成をクリックします。
- キーはすぐにコピーしてください。表示は一度だけです。紛失した場合は無効にして、新しいキーを作成してください。
| 設定 | 内容 |
|---|---|
| 読み取り | プログラム設定、会員、ポイント履歴、特典、ランク。 |
| ポイントの付与・減算 | 会員の残高を調整。 |
| 特典の交換 | 会員のポイントを特典に交換し、割引コードを作成。 |
| 会員の管理 | お客様の登録と誕生日の保存。 |
Webhookのエンドポイントを追加する
Webhookを使うと、何かが起きた瞬間にサーバーへ通知されるため、繰り返し問い合わせる必要がありません。
- API・Webhookのエンドポイントを追加で、エンドポイントURLを入力します。
https://で始まる公開アドレスが必要です。 - イベントで送信する内容を選び、エンドポイントを追加をクリックします。
- 表示された署名シークレットをコピーします。リクエストがLoyalviaからのものか、サーバーで確認するために使います。表示は一度だけです。
- テストを送信をクリックして、エンドポイントが応答するか確認します。
各エンドポイントには、有効かエラーありか、最後に送信した日時が表示されます。50回続けて失敗すると停止中になります。サーバーを修正してから再開するをクリックしてください。エンドポイントは5個まで作成できます。
Shopify Flow
Shopify FlowのワークフローでLoyalviaを使えます。プログラムで何かが起きたときにワークフローを開始したり、任意のワークフローからポイントを変更したりできます。FlowのLoyalviaの下に表示され、ここでの設定は不要です。
| 設定 | 内容 |
|---|---|
| トリガー | Loyalty member joined, Loyalty points changed, Loyalty tier changed, Loyalty reward redeemed |
| アクション | Adjust loyalty points, Enroll customer in loyalty program |
例:レビュー投稿で50ポイントを付与、Goldに到達したお客様にタグを付ける、新しい会員をKlaviyoのリストに追加する。
開発者向けリファレンス
APIの呼び出しとWebhookの受信に必要な情報です。リファレンスは英語です。
Authentication
Send your API key as a bearer token on every request. The key decides the store, so there's no shop parameter. Requests and responses are JSON.
curl https://api.loyalvia.com/v1/members/7023421390 \
-H "Authorization: Bearer lv_live_..."Keys are secret: call the API from your server only, never from a mobile app or browser code. Mobile apps and headless storefronts call your own backend, which calls Loyalvia.
Endpoints
Members are addressed by their numeric Shopify customer id. Texts meant for shoppers (reward names, ways to earn, history lines) follow ?locale=, for example ?locale=fr; the default is English.
| Method and path | Access | What it does |
|---|---|---|
| GET /program | read | Program name, points name, ways to earn, rewards and VIP tiers. |
| GET /members?email= | read | Finds a member by email (any letter case). |
| POST /members | write_members | Enrolls a Shopify customer: {"customerId": "7023421390"}. Name and email come from Shopify. Returns 201, or 200 with the existing member. |
| GET /members/{customerId} | read | Balance, pending and lifetime points, tier, next tier, referral code, birthday. |
| GET /members/{customerId}/activity | read | Points history, newest first. ?limit= 1–100 (default 25); pass nextCursor back as ?cursor= for the next page. |
| GET /members/{customerId}/rewards | read | The store's rewards, each with redeemable for this member. |
| GET /members/{customerId}/redemptions | read | The member's latest 50 reward codes. |
| POST /members/{customerId}/points | write_points | Adds or removes points: {"points": 50, "reason": "Product review"}. Needs an Idempotency-Key. |
| POST /members/{customerId}/redeem | redeem | Spends points on a reward and returns its discount code: {"rewardId": "..."}. Needs an Idempotency-Key. |
| PUT /members/{customerId}/birthday | write_members | {"month": 5, "day": 4}. Saved once, as in the widget. |
Example: a member
GET https://api.loyalvia.com/v1/members/7023421390
{
"member": {
"customerId": "7023421390",
"email": "jane@example.com",
"firstName": "Jane",
"lastName": "Doe",
"balance": 640,
"pendingPoints": 120,
"lifetimePoints": 1840,
"tier": { "id": "6650c1...", "name": "Silver" },
"nextTier": { "id": "6650c2...", "name": "Gold", "pointsNeeded": 160 },
"referralCode": "JANE7K2",
"referralsCount": 3,
"birthday": { "month": 5, "day": 4 },
"ordersCount": 9,
"totalSpent": 412.5,
"enrolledAt": "2026-03-02T10:14:00.000Z",
"lastActivityAt": "2026-10-20T08:01:12.000Z"
}
}A referral link is your store's address with ?ref= and the code, for example https://your-store.com/?ref=JANE7K2.
Example: add points
curl -X POST https://api.loyalvia.com/v1/members/7023421390/points \
-H "Authorization: Bearer lv_live_..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: review-88412" \
-d '{"points": 50, "reason": "Product review"}'The answer is the member with the new balance. The member gets the same emails as for an adjustment in the app, and the customer's history in the app shows the change as API with your key's name. points is a whole number up to 100,000 either way; removing more than the member's balance is refused.
Idempotency
Adding points and redeeming need an Idempotency-Key header: any unique string up to 255 characters, such as your own review or order id. If a request is retried with the same key within 24 hours, you get the first answer back (with Idempotent-Replayed: true) and nothing happens twice. A key reused for a different request is refused.
Errors
{ "error": { "code": "insufficient_points", "message": "..." } }| Status | Common codes |
|---|---|
| 400 | invalid_json, invalid_customer_id, invalid_points, idempotency_key_required |
| 401 | unauthorized: missing, wrong or revoked key |
| 402 | plan_required: the store isn't on the Plus plan |
| 403 | insufficient_scope: the key doesn't have this access |
| 404 | member_not_found, customer_not_found, reward_unavailable, not_found |
| 409 | request_in_progress, birthday_already_set |
| 422 | insufficient_points, tier_required, invalid_date, idempotency_key_reused |
| 429 | rate_limited, daily_limit |
| 5xx | internal_error, redeem_failed, store_unavailable: safe to retry |
Rate limits
10 requests a second per key, with bursts of up to 40, and 50,000 requests a day per store (reset at midnight UTC). Every answer has X-RateLimit-Limit and X-RateLimit-Remaining; a 429 has Retry-After in seconds.
Webhook events
| Event | Sent when |
|---|---|
| member.enrolled | A customer joins the program. |
| points.changed | Points are earned, spent, removed, expired, or released after the pending period (type: release). |
| tier.changed | A member moves to another VIP tier. |
| reward.redeemed | A member spends points on a reward; includes the discount code. |
Members moved in with Import, and tier moves caused by editing your VIP tiers, don't send events. Each request is a POST with a JSON body like this:
{
"id": "6720f4c1a9e3b2d5c8f01a77",
"event": "points.changed",
"createdAt": "2026-10-26T14:03:11.204Z",
"shop": "your-store.myshopify.com",
"data": {
"customerId": "7023421390",
"activityId": "6720f4c1a9e3b2d5c8f01a70",
"type": "earn",
"source": "purchase",
"points": 120,
"pending": true,
"balance": 640,
"pendingPoints": 120,
"lifetimePoints": 1840
}
}Bodies carry ids and numbers, not names or emails; read those through the API. The headers are X-Loyalvia-Event, X-Loyalvia-Delivery (the same as id, to spot duplicates), X-Loyalvia-Shop and X-Loyalvia-Signature.
Check the signature
X-Loyalvia-Signature looks like t=1793023391,v1=5f2c…: v1 is the hex HMAC-SHA256 of t, a dot and the raw body, keyed with your endpoint's signing secret. Check it against the raw body, before parsing, and refuse old timestamps:
import { createHmac, timingSafeEqual } from "node:crypto";
function verify(rawBody, header, secret, toleranceSeconds = 300) {
const parts = Object.fromEntries(header.split(",").map((p) => p.split("=")));
const expected = createHmac("sha256", secret)
.update(`${parts.t}.${rawBody}`)
.digest("hex");
const fresh = Math.abs(Date.now() / 1000 - Number(parts.t)) <= toleranceSeconds;
return (
fresh &&
expected.length === parts.v1?.length &&
timingSafeEqual(Buffer.from(expected), Buffer.from(parts.v1))
);
}Answers and retries
Answer with any 2xx status within 5 seconds; do slow work after answering. Anything else is retried after 1 minute, 10 minutes, 1 hour and 6 hours. Redirects aren't followed. After 50 failed attempts in a row the endpoint is turned off; fix it, then turn it back on in the app. Events can arrive more than once or out of order, so use id to skip duplicates and createdAt to order them.