Plug Software
Retour à Loyalvia
Menu de la documentation

Gérer votre programme

API et webhooks

Laissez vos propres systèmes, ou d'autres apps que vous utilisez, lire et modifier votre programme de fidélité : afficher les soldes dans une app mobile, offrir des points pour un avis, ou réagir quand un membre atteint un nouveau niveau.

Remarque: L'API et les webhooks sont inclus dans le forfait Plus. Les boutiques early bird ont toutes les fonctionnalités Pro gratuitement ; Plus est un forfait payant distinct. Voir Forfaits et facturation.

Ce que vous pouvez créer

  • Une app mobile ou une boutique headless qui affiche les points, l'historique et les récompenses, et permet de les échanger.
  • Des points venant d'autres apps : avis, quiz, événements de votre boutique ou votre propre back-office.
  • La synchronisation des soldes et niveaux avec un outil d'e-mailing, de support ou de CRM.

Créer une clé API

  1. Ouvrez API et webhooks dans le menu de l'app.
  2. Sous Créer une clé API, donnez-lui un Nom qui indique où elle sert, par exemple « App mobile » ou le nom de l'autre app.
  3. Sous Accès, cochez uniquement ce dont elle a besoin, puis cliquez sur Créer la clé.
  4. Copiez la clé tout de suite. Elle n'est affichée qu'une fois ; si vous la perdez, révoquez-la et créez-en une nouvelle.
ParamètreRôle
LectureRéglages du programme, membres, historique des points, récompenses et niveaux.
Ajouter et retirer des pointsModifier le solde des membres.
Échanger des récompensesUtiliser les points d'un membre pour une récompense et créer son code de réduction.
Gérer les membresInscrire des clients et enregistrer leur anniversaire.
Important: Gardez vos clés secrètes. Utilisez-les uniquement depuis un serveur, jamais dans une app mobile ni dans le code de votre boutique, où n'importe qui pourrait les copier. Si une clé est divulguée, cliquez immédiatement sur Révoquer à côté. Vous pouvez avoir jusqu'à 10 clés, et la désinstallation de l'app les révoque toutes.

Ajouter un endpoint de webhook

Les webhooks préviennent votre serveur dès qu'il se passe quelque chose, sans que vous ayez à demander sans cesse.

  1. Dans API et webhooks, sous Ajouter un endpoint, saisissez l'URL de l'endpoint : une adresse publique commençant par https://.
  2. Sous Événements, choisissez ce qui doit être envoyé, puis cliquez sur Ajouter l'endpoint.
  3. Copiez le secret de signature affiché. Votre serveur s'en sert pour vérifier que les requêtes viennent de Loyalvia. Il n'est affiché qu'une fois.
  4. Cliquez sur Envoyer un test pour vérifier que votre endpoint répond.

Chaque endpoint indique s'il est Actif ou En échec et quand il a été appelé pour la dernière fois. Après 50 tentatives échouées d'affilée, il est Désactivé ; corrigez votre serveur, puis cliquez sur Réactiver. Vous pouvez avoir jusqu'à 5 endpoints.

Shopify Flow

Utilisez Loyalvia dans les flux Shopify Flow : lancez un flux quand quelque chose se passe dans votre programme, ou modifiez des points depuis n'importe quel flux. Ils apparaissent dans Flow sous Loyalvia ; rien à configurer ici.

ParamètreRôle
DéclencheursLoyalty member joined, Loyalty points changed, Loyalty tier changed, Loyalty reward redeemed
ActionsAdjust loyalty points, Enroll customer in loyalty program

Par exemple : offrir 50 points pour un avis client, ajouter une balise aux clients qui atteignent Gold, ou ajouter les nouveaux membres à une liste Klaviyo.

Référence pour les développeurs

Tout ce dont un développeur a besoin pour appeler l'API et recevoir les webhooks. La référence est en anglais.

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 pathAccessWhat it does
GET /programreadProgram name, points name, ways to earn, rewards and VIP tiers.
GET /members?email=readFinds a member by email (any letter case).
POST /memberswrite_membersEnrolls a Shopify customer: {"customerId": "7023421390"}. Name and email come from Shopify. Returns 201, or 200 with the existing member.
GET /members/{customerId}readBalance, pending and lifetime points, tier, next tier, referral code, birthday.
GET /members/{customerId}/activityreadPoints history, newest first. ?limit= 1–100 (default 25); pass nextCursor back as ?cursor= for the next page.
GET /members/{customerId}/rewardsreadThe store's rewards, each with redeemable for this member.
GET /members/{customerId}/redemptionsreadThe member's latest 50 reward codes.
POST /members/{customerId}/pointswrite_pointsAdds or removes points: {"points": 50, "reason": "Product review"}. Needs an Idempotency-Key.
POST /members/{customerId}/redeemredeemSpends points on a reward and returns its discount code: {"rewardId": "..."}. Needs an Idempotency-Key.
PUT /members/{customerId}/birthdaywrite_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": "..." } }
StatusCommon codes
400invalid_json, invalid_customer_id, invalid_points, idempotency_key_required
401unauthorized: missing, wrong or revoked key
402plan_required: the store isn't on the Plus plan
403insufficient_scope: the key doesn't have this access
404member_not_found, customer_not_found, reward_unavailable, not_found
409request_in_progress, birthday_already_set
422insufficient_points, tier_required, invalid_date, idempotency_key_reused
429rate_limited, daily_limit
5xxinternal_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

EventSent when
member.enrolledA customer joins the program.
points.changedPoints are earned, spent, removed, expired, or released after the pending period (type: release).
tier.changedA member moves to another VIP tier.
reward.redeemedA 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.

Vous ne trouvez pas ce que vous cherchez, ou vous avez rencontré un bug ? Contacter le support ou écrivez à support@loyalvia.com