Referralmeter

referralmeter-js

Referralmeter 向けの、依存関係のない最小限のサーバーサイド SDK です。AI アプリ向けのアフィリエイトプログラムを提供します。コーディングエージェントは、1 つのプロンプトで Referralmeter を導入できます。コミッションは、お使いの決済プロバイダーの署名付きウェブフック（Stripe、Polar、Lemon Squeezy、Paddle、Creem、Dodo Payments）から算出されるため、ほとんどのアプリではこのパッケージは必要ありません。トラッキングスクリプトを導入し、決済プロバイダーを接続するだけで完了です。

このパッケージは、次の場合にのみ使用してください。

• サインアップがサーバー上で完了し、ブラウザのスクリプトがブロックされた場合でも記録したい場合、または
• Referralmeter がネイティブに接続できないサービスを通じて課金している場合。

REST API を薄くラップしたもので、依存関係はなく、Node 18+ およびグローバルな fetch が使えるあらゆるランタイムで動作します。

インストール

npm install github:ajussis/referralmeter-js

（npm レジストリにはありません。GitHub から直接インストールするか、src/index.js をコピーしてください。ファイルは 1 つだけです。）

使い方

import { createClient } from "referralmeter-js";

const referralmeter = createClient({ secretKey: process.env.REFERRALMETER_SECRET_KEY });

// After your own signup completes server-side:
await referralmeter.recordSignup({
  email: "[email protected]",
  external_id: "user_42",
  referral: req.cookies.sf_ref, // what referralmeter.ref() returned in the browser, or an affiliate code
  ip: req.ip,
});

// Billing you don't connect to natively:
await referralmeter.recordSale({
  event_id: "pay_123", // your idempotency key — sending it twice records it once
  amount: 4900, // integer cents
  currency: "usd",
  customer_external_id: "user_42",
  kind: "subscription", // subscription | one_time | credits | usage
});

await referralmeter.recordRefund({
  event_id: "ref_9",
  payment_id: "pay_123",
  amount: 4900,
});

フィールドの完全なリファレンス：referralmeter.com/docs/server-side。

このパッケージがある理由

Referralmeter はエージェントファーストです。AI コーディングエージェントは、curl の構文を推測することなく、1 つのプロンプトでアフィリエイトトラッキングを導入できる必要があります。このパッケージがあれば、手作業で fetch の呼び出しを組み立てる代わりに、プロンプトで npm install github:ajussis/referralmeter-js と指定できます。また、エージェント（または人）が GitHub でアフィリエイトトラッキング SDK を検索したときに、Referralmeter が見つかるようになります。

ライセンス

MIT