Plug Software
Torna a Loyalvia
Menu della documentazione

Gestisci il programma

API e webhook

Permetti ai tuoi sistemi, o ad altre app che usi, di leggere e aggiornare il tuo programma fedeltà: mostrare i saldi in un'app mobile, assegnare punti per una recensione o reagire quando un membro raggiunge un nuovo livello.

Nota: L'API e i webhook sono inclusi nel piano Plus. I negozi early bird hanno gratis tutte le funzioni Pro; Plus è un piano a pagamento separato. Vedi Piani e fatturazione.

Cosa puoi creare

  • Un'app mobile o un negozio headless che mostra punti, cronologia e premi, e permette di riscattarli.
  • Punti da altre app: recensioni, quiz, eventi del tuo negozio o il tuo gestionale.
  • La sincronizzazione di saldi e livelli con uno strumento di email, assistenza o CRM.

Crea una chiave API

  1. Vai su API e webhook nel menu dell'app.
  2. In Crea una chiave API, dalle un Nome che dica dove la usi, ad esempio "App mobile" o il nome dell'altra app.
  3. In Accesso, spunta solo ciò che serve, poi fai clic su Crea chiave.
  4. Copia subito la chiave. Viene mostrata una sola volta; se la perdi, revocala e creane una nuova.
ImpostazioneA cosa serve
LetturaImpostazioni del programma, membri, cronologia punti, premi e livelli.
Aggiungere e togliere puntiModificare il saldo dei membri.
Riscattare premiUsare i punti di un membro per un premio e crearne il codice sconto.
Gestire i membriIscrivere clienti e salvare i compleanni.
Importante: Tieni segrete le chiavi. Usale solo da un server, mai dentro un'app mobile o nel codice del tuo negozio, dove chiunque potrebbe copiarle. Se una chiave viene diffusa, fai subito clic su Revoca accanto a essa. Puoi avere fino a 10 chiavi, e disinstallare l'app le revoca tutte.

Aggiungi un endpoint webhook

I webhook avvisano il tuo server appena succede qualcosa, così non devi chiedere di continuo.

  1. In API e webhook, sotto Aggiungi un endpoint, inserisci l'URL dell'endpoint: un indirizzo pubblico che inizia con https://.
  2. In Eventi, scegli cosa inviare, poi fai clic su Aggiungi endpoint.
  3. Copia il secret di firma che compare. Il tuo server lo usa per verificare che le richieste arrivino da Loyalvia. Viene mostrato una sola volta.
  4. Fai clic su Invia test per verificare che il tuo endpoint risponda.

Ogni endpoint mostra se è Attivo o Con errori e quando è stato inviato l'ultima volta. Dopo 50 tentativi falliti di fila diventa Disattivato; sistema il tuo server, poi fai clic su Riattiva. Puoi avere fino a 5 endpoint.

Shopify Flow

Usa Loyalvia nei flussi di Shopify Flow: avvia un flusso quando succede qualcosa nel tuo programma o modifica i punti da qualsiasi flusso. Li trovi in Flow sotto Loyalvia; qui non c'è nulla da configurare.

ImpostazioneA cosa serve
TriggerLoyalty member joined, Loyalty points changed, Loyalty tier changed, Loyalty reward redeemed
AzioniAdjust loyalty points, Enroll customer in loyalty program

Ad esempio: dare 50 punti quando un cliente lascia una recensione, aggiungere un tag a chi raggiunge Gold o inserire i nuovi membri in una lista Klaviyo.

Riferimento per sviluppatori

Tutto ciò che serve a uno sviluppatore per chiamare l'API e ricevere i webhook. Il riferimento è in inglese.

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.