How E-Earn works, and how to run it

export interface PlatformConnector {
  key: string;          // "eproperties"
  name: string;          // "eProperties"
  description: string;
  siteUrl: string;
  withdrawUrl: string;   // where the affiliate actually withdraws
  currency: string;

  authenticate(credentials: PlatformCredentials): Promise<PlatformAuthResult>;
  getDashboard(token: string): Promise<NormalizedDashboard>;
}

POST /api/login
{ "email": "affiliate@example.com", "password": "..." }

-> 200
{
  "status": "success",
  "message": "Login successful",
  "data": {
    "authorization": { "token": "eyJ...", "type": "bearer", "expires_in": 3600 }
  }
}

GET /api/referral/dashboard
Authorization: Bearer eyJ...

-> 200
{
  "status": "success",
  "data": {
    "referral_code": "ESC-4F21",
    "referral_link": "https://eschool.ng/register?ref=ESC-4F21",
    "summary": {
      "total_referrals": 12,
      "successful_referrals": 8,
      "total_earned_kobo": 450000,
      "available_kobo": 200000,
      "pending_kobo": 100000,
      "paid_out_kobo": 150000
    },
    "recent_commissions": [
      { "referred_name": "Jane D.", "plan_type": "Termly plan", "amount_kobo": 5000, "status": "paid", "earned_at": "2026-08-20T10:00:00Z" }
    ]
  }
}

Subject: E-Earn integration — info needed for <Platform>

To wire <Platform> into the E-Earn affiliate hub, could you send over:

1. API base URL — local/.test, staging, and production
2. Login endpoint: method, path, request body, and a full sample response JSON
   (redact real tokens) — where is the bearer token and its expiry?
3. Referral/commission dashboard endpoint(s): path(s), required auth header,
   and a full sample response JSON
4. Does the response follow { status, message, data }, or something else?
5. Public site URL (where a non-affiliate signs up)
6. Withdrawal page URL (where a connected affiliate cashes out)
7. Currency, and whether amounts are minor units (kobo) or decimal (naira)
8. One working staging login (email + password) we can build/test against

Nothing needs to change on your end beyond documenting what already exists —
E-Earn only calls your existing public API. iF you've further questions, kindly contact the developer, Adewale via +2348133169835

import {
  ConnectorAuthError,
  type NormalizedDashboard,
  type PlatformAuthResult,
  type PlatformConnector,
  type PlatformCredentials,
} from "./types";
import { platformJsonRequest } from "./http";

const API_BASE = process.env.EXAMPLE_API_URL ?? "http://api-example.test/api";

interface LoginData {
  authorization: { token: string; type: string; expires_in: number };
}

interface ExampleDashboardData {
  referral_code: string;
  referral_link: string;
  summary: {
    total_referrals: number;
    successful_referrals: number;
    total_earned_kobo: number;
    available_kobo: number;
    pending_kobo: number;
    paid_out_kobo: number;
  };
  recent_commissions: Array<{
    referred_name: string;
    plan_type: string;
    amount_kobo: number;
    status: string;
    earned_at: string;
  }>;
}

export const exampleConnector: PlatformConnector = {
  key: "example",
  name: "Example",
  description: "One-line description shown on the connect grid.",
  siteUrl: "https://example.ng",
  withdrawUrl: "https://example.ng/dashboard/referral/withdraw",
  currency: "NGN",

  async authenticate(credentials: PlatformCredentials): Promise<PlatformAuthResult> {
    try {
      const data = await platformJsonRequest<LoginData>(`${API_BASE}/login`, {
        method: "POST",
        body: JSON.stringify(credentials),
      });
      return {
        token: data.authorization.token,
        expiresAt: new Date(Date.now() + data.authorization.expires_in * 1000),
      };
    } catch (err) {
      throw new ConnectorAuthError(
        err instanceof Error ? err.message : "Invalid Example credentials.",
      );
    }
  },

  async getDashboard(token: string): Promise<NormalizedDashboard> {
    const data = await platformJsonRequest<ExampleDashboardData>(
      `${API_BASE}/referral/dashboard`,
      { headers: { Authorization: `Bearer ${token}` } },
    );
    return {
      referralCode: data.referral_code,
      referralLink: data.referral_link,
      totalReferrals: data.summary.total_referrals,
      successfulReferrals: data.summary.successful_referrals,
      totalEarnedMinor: data.summary.total_earned_kobo,
      availableMinor: data.summary.available_kobo,
      pendingMinor: data.summary.pending_kobo,
      paidOutMinor: data.summary.paid_out_kobo,
      currency: "NGN",
      recentActivity: (data.recent_commissions ?? []).map((c) => ({
        label: `${c.referred_name} · ${c.plan_type}`,
        amountMinor: c.amount_kobo,
        status: c.status,
        occurredAt: c.earned_at,
      })),
    };
  },
};

export const connectorRegistry: PlatformConnector[] = [
  epropertiesConnector,
  ehotelsConnector,
  // exampleConnector,
];

npm install
cp .env.example .env   # fill in real secrets
npx prisma migrate dev # create/update the SQLite schema
npm run dev             # http://localhost:3000 (or next free port)

src/
  app/
    page.tsx                     # landing page
    docs/page.tsx                 # this page
    login/, register/             # hub auth pages
    dashboard/
      layout.tsx                  # auth-gated shell
      page.tsx                    # aggregated overview
      platforms/page.tsx          # connect/manage grid
      platforms/[platform]/       # per-platform detail
    actions/
      auth.ts                     # register/login/logout server actions
      platforms.ts                 # connect/refresh/disconnect server actions
  components/                     # shared UI (forms, buttons, badges, docs/*)
  lib/
    connectors/
      types.ts                    # the PlatformConnector contract
      eproperties.ts, ehotels.ts  # per-platform adapters
      registry.ts                 # the list every page reads from
    auth.ts, session.ts           # hub identity + cookie session
    crypto.ts                     # AES-256-GCM helpers
    db.ts                         # Prisma client singleton
    connections.ts                # merges registry + DB rows into view models
prisma/schema.prisma               # User / PlatformConnection / DashboardSnapshot