← すべての統合
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
GitHub でソースを見る →

2 つの統合モード

同じプラグインコードが両モードをサポート。今日は OAuth2 モードで開始し、後で設定切り替えでブリッジを追加 — データ移行不要。

OAuth2 モード
予定

あなたの DB に集中型ロイヤルティ、OAuth2 で Deakee と同期。チェーンもエクスチェンジも使いません — でも顧客は Deakee で残高を見られ、Deakee バウチャーを受け取れます。

  • 現在の deakee.com/api/oauth/* バックエンドで動作。
  • トークン無し、発行者としての法的リスク無し。
  • 設定切り替えでブリッジモードにアップグレード可能。
ブリッジモード
予定

ERC-8063 コントラクトをデプロイ。顧客は集中型残高をオンチェーントークンに変換し、Deakee エクスチェンジで取引できます。

  • エクスチェンジ上場とクロスブランド引き換えを追加。
  • Deakee リレイヤーが必要(未公開)。
  • OAuth2 モードと同じプラグインコード — 準備ができたら有効化。

インストール

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

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

Deakee がプラグインに接続する方法

パートナー API キーで Deakee リレイヤーへの呼び出しを認証します。OAuth2 の authorize/token URL は顧客ごとに 1 回、ウォレットアドレスの取得に使用されます(スコープ:identity のみ)。

authorize_urlhttps://deakee.com/oauth2/authorize (scope=identity)
token_urlhttps://deakee.com/oauth2/token
api_base_urlhttps://deakee.com/api/relayer/v1

適合性を検証

本番公開の前に公式の適合性検証ツールを実行してください。集中型台帳、identity OAuth フロー、ブリッジの mint/burn 接続、冪等性を検査します。

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

困っていますか? 完全な README を読むか、github.com/deakee/loyalty/issues で issue を開いてください。