MakePay NPM SDK

Przegląd

MakePay npm SDK to biblioteka JavaScript i TypeScript z typem dla po stronie serwera Integracje MakePay. Obejmuje uwierzytelnianie kluczem API, hostowany link do płatności operacji, ustawień MakePay i podpisanej weryfikacji webhook.

Pakiet:

@makecrypto/makepay

Instalacja

npm install @makecrypto/makepay

pnpm add @makecrypto/makepay

SDK jest przeznaczony dla Node.js 18 lub nowszego i wykorzystuje środowisko wykonawcze fetch wdrożenie.

Uwierzytelnianie

Utwórz klucz MakePay API z obszaru deweloperskiego sprzedawcy i sklepu MakeCrypto klucz tajny tylko na twoim serwerze.

import { MakePayClient } from "@makecrypto/makepay";

const makepay = new MakePayClient({
  keyId: process.env.MAKEPAY_KEY_ID!,
  keySecret: process.env.MAKEPAY_KEY_SECRET!,
  // Optional: override only when MakePay gives you a custom checkout origin.
  checkoutBaseUrl: "https://makepay.io",
});

SDK wysyła nagłówki x-makecrypto-key-id i x-makecrypto-key-secret do partner MakePay API.

Utwórz łącze do płatności

const response = await makepay.createPaymentLink({
  title: "Order #1042",
  description: "Checkout for order #1042",
  amount: "129.99",
  currency: "USDT",
  orderId: "order_1042",
  customerEmail: "buyer@example.com",
  returnUrl: "https://merchant.example/orders/1042",
  successUrl: "https://merchant.example/orders/1042/success",
  failureUrl: "https://merchant.example/orders/1042/pay",
  expirationTime: "12h",
});

console.log(response.paymentLink);

Wyślij prośbę o płatność MakePay e-mailem podczas tworzenia:

await makepay.createPaymentLink(payload, {
  sendPaymentRequestEmail: true,
});

Wbudowany Checkout

Użyj hostowanych adresów URL checkout do przekierowań lub pomocników osadzania, gdy Twój interfejs utrzymuje kupującego na stronie sprzedawcy.

import {
  buildMakePayEmbeddedCheckoutUrl,
  buildMakePayHostedCheckoutUrl,
  mountMakePayCheckout,
  openMakePayCheckout,
} from "@makecrypto/makepay";

const paymentUid = response.paymentLink.uid;

const hostedUrl = buildMakePayHostedCheckoutUrl(paymentUid);
const embedUrl = buildMakePayEmbeddedCheckoutUrl(paymentUid, {
  parentOrigin: "https://merchant.example",
});

await openMakePayCheckout({
  paymentUid,
  onEvent(event) {
    if (event.type === "makepay.payment.redirect_requested") {
      window.location.assign(String(event.payload?.redirectUrl || hostedUrl));
    }
  },
});

mountMakePayCheckout({
  container: "#makepay-checkout",
  paymentUid,
});

W przypadku statycznych stron CMS buildMakePayEmbedButtonHtml(paymentUid) zwraca a fragment kodu ładujący skrypt modalny MakePay.

Przeczytaj i zaktualizuj linki

await makepay.listPaymentLinks();
await makepay.getPaymentLink("PAYMENT_LINK_UID");

await makepay.updatePaymentLink("PAYMENT_LINK_UID", {
  status: "paused",
});

await makepay.sendPaymentRequestEmail("PAYMENT_LINK_UID", "buyer@example.com");

Ustawienia

await makepay.getSettings();

await makepay.updateSettings({
  callbackUrl: "https://merchant.example/webhooks/makepay",
});

Weryfikacja Webhook

Przeczytaj dokładnie surową treść przed analizą JSON.

import { parseMakePayWebhook } from "@makecrypto/makepay";

export async function POST(request: Request) {
  const rawBody = await request.text();
  const event = parseMakePayWebhook(
    rawBody,
    request.headers.get("x-makepay-signature"),
    process.env.MAKEPAY_WEBHOOK_SECRET!,
  );

  if (event.event?.type === "status_changed") {
    // Update your local order.
  }

  return new Response("ok");
}

Użyj verifyMakePayWebhook, gdy potrzebujesz tylko wyniku logicznego.

Obsługa błędów

Wywołania API zgłaszają MakePayError. Zawiera status HTTP i zdekodowaną odpowiedź ciało.

import { MakePayError } from "@makecrypto/makepay";

try {
  await makepay.getPaymentLink("PAYMENT_LINK_UID");
} catch (error) {
  if (error instanceof MakePayError) {
    console.error(error.status, error.responseBody);
  }
}

Układ źródłowy

Źródło kanoniczne znajduje się w apps/plugins/npm-sdk. Opublikowany pakiet npm zawiera skompilowane deklaracje ESM JavaScript i TypeScript z dist.

Informacje o wydaniu

Pakiet jest publikowany jako @makecrypto/makepay z dostępem publicznym. Zwolnij publikowanie powinno używać tokena automatyzacji npm w organizacji makecrypto lub token obsługujący OTP, gdy wymagane jest 2FA.