Tier 2 — Full Deakee partner

SDK

Any Node.js app (Express, Fastify, Hono, …)

For custom stacks, headless setups, or anything that doesn't fit a packaged plugin. Provides the canonical centralized-loyalty primitives (member balances, transaction log, refund clawback) plus the relayer client for bridging on-chain.

npm

npm install @deakee/loyalty-sdk

Ver código en GitHub →

Dos modos de integración

El mismo código de plugin soporta ambos modos. Empieza en modo OAuth2 hoy; añade el puente más tarde con un cambio de config — sin migración de datos.

Modo OAuth2

planificado

Lealtad centralizada en tu DB sincronizada con Deakee via OAuth2. Sin cadena, sin exchange — pero los clientes ven saldos en Deakee y puedes aceptar vouchers Deakee.

Funciona contra el backend actual deakee.com/api/oauth/*.
Sin tokens, sin exposición legal como emisor.
Migra al modo puente con un cambio de config.

Modo puente

planificado

Despliega un contrato ERC-8063; los clientes pueden acuñar saldo centralizado a tokens on-chain y operar en el exchange de Deakee.

Añade listado en exchange y canje entre marcas.
Requiere el relayer de Deakee (aún no liberado).
Mismo código que modo OAuth2 — actívalo cuando estés listo.

Instalar

npm install @deakee/loyalty-sdk
Run the published migrations against your DB to create the loyalty tables.
Use members.credit() in your order-complete logic; bridge.withdraw() from your customer-account UI.
Mount the identity OAuth callback route so customers can link their Deakee wallet.

Ejemplo

import { DeakeeLoyalty } from "@deakee/loyalty-sdk";

const loyalty = new DeakeeLoyalty({
  apiKey: process.env.DEAKEE_API_KEY,
  contractAddress: process.env.DEAKEE_CONTRACT,
  db: myKnexInstance,
});

// Centralized earn:
await loyalty.members.credit({
  userId, points: 50, reference: `order_${id}`,
});

// User-initiated bridge to chain:
await loyalty.bridge.withdraw({ userId, amount: 500 });

Cómo Deakee se conecta a tu plugin

Tu API key de partner autentica las llamadas al relayer de Deakee. Las URLs OAuth2 authorize/token se usan una vez por cliente para obtener la dirección de la wallet (alcance: identity únicamente).

authorize_url	`https://deakee.com/oauth2/authorize (scope=identity)`
token_url	`https://deakee.com/oauth2/token`
api_base_url	`https://deakee.com/api/relayer/v1`

Verificar conformidad

Antes de producción, ejecuta el verificador oficial. Comprueba el libro centralizado, el flujo OAuth de identidad, el cableado de mint/burn del puente y la idempotencia.

npx @deakee/loyalty-verifier \
  --partner-api-key   <your key> \
  --plugin-url        <your plugin URL> \
  --contract-address  <your ERC-8063 contract> \
  --test-user-email   test@example.com

¿Atascado? Lee el README completo o abre un issue en github.com/deakee/loyalty/issues.