Plug Software
Voltar à Loyalvia
Menu da documentação

Gira o seu programa

API e webhooks

Deixe os seus próprios sistemas, ou outras apps que usa, lerem e atualizarem o seu programa de fidelidade: mostrar saldos numa app móvel, dar pontos por uma avaliação ou reagir quando um membro chega a um novo nível.

Nota: A API e os webhooks vêm com o plano Plus. Lojas early bird têm todos os recursos do Pro grátis; o Plus é um plano pago separado. Veja Planos e faturação.

O que pode criar

  • Um app móvel ou loja headless que mostra pontos, histórico e recompensas, e permite resgatá-las.
  • Pontos vindos de outras apps: avaliações, quizzes, eventos da sua loja ou o seu próprio back office.
  • Sincronizar saldos e níveis com uma ferramenta de e-mail, atendimento ou CRM.

Criar uma chave de API

  1. Vá em API e webhooks no menu da app.
  2. Em Criar uma chave de API, dê um Nome que diga onde ela é usada, como "App móvel" ou o nome do outra app.
  3. Em Acesso, marque só o necessário e clique em Criar chave.
  4. Copie a chave de imediato. Ela é mostrada uma única vez; se perdê-la, revogue-a e crie uma nova.
DefiniçãoO que faz
LeituraDefinições do programa, membros, histórico de pontos, recompensas e níveis.
Adicionar e remover pontosAjustar o saldo dos membros.
Resgatar recompensasUsar os pontos de um membro numa recompensa e criar o código de desconto.
Gerir membrosInscrever clientes e guardar aniversários.
Importante: Mantenha as chaves em segredo. Use-as só a partir de um servidor, nunca dentro de uma app móvel ou no código da sua loja, onde qualquer pessoa poderia copiá-las. Se uma chave vazar, clique em Revogar ao lado dela de imediato. Pode ter até 10 chaves, e desinstalar a app revoga todas.

Adicionar um endpoint de webhook

Os webhooks avisam o seu servidor assim que algo acontece, para si não precisar perguntar o tempo todo.

  1. Em API e webhooks, em Adicionar um endpoint, informe a URL do endpoint: um endereço público que comece com https://.
  2. Em Eventos, escolha o que enviar e clique em Adicionar endpoint.
  3. Copie o segredo de assinatura que aparece. O seu servidor o usa para conferir que as pedidos vêm da Loyalvia. Ele é mostrado uma única vez.
  4. Clique em Enviar teste para conferir se o seu endpoint responde.

Cada endpoint mostra se está Ativo ou Com falhas e quando foi enviado pela última vez. Depois de 50 tentativas seguidas com falha, ele fica Desativado; corrija o seu servidor e clique em Reativar. Pode ter até 5 endpoints.

Shopify Flow

Use o Loyalvia em fluxos do Shopify Flow: inicie um fluxo quando algo acontece no seu programa ou altere pontos a partir de qualquer fluxo. Aparecem no Flow em Loyalvia; não há nada a configurar aqui.

DefiniçãoO que faz
AcionadoresLoyalty member joined, Loyalty points changed, Loyalty tier changed, Loyalty reward redeemed
AçõesAdjust loyalty points, Enroll customer in loyalty program

Por exemplo: dar 50 pontos quando um cliente deixa uma avaliação, adicionar uma etiqueta a quem chega ao Gold ou incluir novos membros numa lista do Klaviyo.

Referência para programadores

Tudo o que um programador precisa para chamar a API e receber webhooks. A referência está em inglês.

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.

Não encontrou o que procurava ou encontrou um erro? Contactar o suporte ou envie um e-mail para support@loyalvia.com