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

Voir le code sur GitHub →

Deux modes d'intégration

Le même code de plugin supporte les deux modes. Démarre en mode OAuth2 aujourd'hui ; ajoute le pont plus tard via une config — sans migration de données.

Mode OAuth2

prévu

Fidélité centralisée dans ta DB, synchronisée avec Deakee via OAuth2. Pas de chaîne, pas d'exchange — mais les clients voient les soldes dans Deakee et tu peux accepter les vouchers Deakee.

Fonctionne sur le backend actuel deakee.com/api/oauth/*.
Pas de tokens, pas d'exposition légale en tant qu'émetteur.
Passage au mode pont via un changement de config.

Mode pont

prévu

Déploie un contrat ERC-8063 ; les clients peuvent transformer leur solde centralisé en tokens on-chain et trader sur l'exchange Deakee.

Ajoute le listing en exchange et l'utilisation entre marques.
Requiert le relais Deakee (pas encore livré).
Même code que le mode OAuth2 — active-le quand prêt.

Installer

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.

Exemple

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 });

Comment Deakee se connecte à ton plugin

Ta clé API partenaire authentifie les appels au relais Deakee. Les URLs OAuth2 authorize/token sont utilisées une fois par client pour récupérer l'adresse du wallet (scope : identity uniquement).

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`

Vérifier la conformité

Avant la mise en production, exécute le vérificateur de conformité officiel. Il vérifie le ledger centralisé, le flux OAuth d'identité, le câblage mint/burn du pont, et l'idempotence.

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

Bloqué ? Lis le README complet ou ouvre une issue à github.com/deakee/loyalty/issues.