Dokumentacja API

Portal klienta API

Generuj podpisane adresy URL portalu klientów MakePay dla zapisanych klientów.

Wygeneruj łącze do portalu

Utwórz łącze do portalu klienta MakePay na podstawie zapisanego profilu klienta MakePay. Generuj link tylko wtedy, gdy klient lub sprzedawca kliknie opcję płatności przekierować lub otworzyć zwrócony adres URL.

POST /api/partner/v1/makepay/customers/{customerId}/portal

customerId akceptuje zapisany UUID klienta lub UID klienta. Treść żądania jest pusty.

curl

curl -X POST "https://www.makecrypto.io/api/partner/v1/makepay/customers/CUSTOMER_ID/portal" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

Uwierzytelnianie

Integracje serwerów uwierzytelniają się za pomocą klucza MakePay API. Sesje przeglądarki mogą wywołaj trasę pulpitu nawigacyjnego o zasięgu firmy, gdy zalogowany użytkownik to zrobi settings.manage w wybranym zespole. Żądania klucza API nie przechodzą przez firmę Identyfikator w adresie URL, ponieważ klucz należy już do jednej firmy.

Nagłówek	Wartość	Uwagi
`x-makecrypto-key-id`	ID klucza MakePay API	Zaczyna się od `mk_makepay_` dla płatniczych API MakePay.
`x-makecrypto-key-secret`	Jednorazowy sekret API	Wyświetlany tylko podczas tworzenia klucza. Przechowuj go w serwerowym menedżerze sekretów.

Odpowiedź

Trasa zwraca obiekt klienta oraz podpisane łącze urls.customerPortal.

json

{
  "ok": true,
  "companyId": "acct_123",
  "customer": {
    "id": "b834dd77-69b8-41a9-a4b6-95bc9dd14c2d",
    "uid": "cus_01hzy4k6p4w9y2x7e2z7n8a2xm",
    "email": "buyer@example.com",
    "name": "Ada Lovelace",
    "clientId": "client_1042",
    "metadata": {
      "source": "api"
    },
    "createdAt": "2026-04-20T10:00:00.000Z",
    "updatedAt": "2026-04-20T10:00:00.000Z",
    "urls": {
      "customerPortal": "https://makepay.io/billing?company=acct_123&customer=cus_01hzy4k6p4w9y2x7e2z7n8a2xm&expires=1776765600&signature=8d1f..."
    }
  },
  "expiresAt": "2026-04-21T10:00:00.000Z"
}

Podpisane parametry adresu URL

Zwrócony adres URL portalu ma następujący kształt:

https://{makepay-or-verified-merchant-domain}/billing?company={companyId}&customer={customerUid}&expires={unixSeconds}&signature={hexHmac}

Parametr	Notatki
`company`	Identyfikator konta firmowego MakeCrypto, do którego należy klient.
`customer`	UID klienta MakePay obejmujący tę firmę.
`expires`	Znacznik czasu Uniksa w sekundach. Linki są ważne przez 24 godziny.
`signature`	Podpis HMAC nad wartościami wersji, firmy, klienta i wygaśnięcia.

MakePay weryfikuje podpis i datę ważności przed załadowaniem jakichkolwiek danych portalu. Zrób nie przechowywać na stałe adresów URL portalu. Regeneruj nowy link po każdym kliknięciu przycisku.

Zakres portalu

Portal pokazuje tylko dane pasujące do podpisanej firmy i klienta:

Podsumowanie profilu klienta i edytowalna nazwa wyświetlana.
Historia płatności dopasowana do adresu e-mail klienta lub identyfikatora klienta.
Aktywne lub bezpłatne linki płatnicze z hostowanymi adresami URL MakePay.
Subskrypcje dopasowane według adresu e-mail klienta lub identyfikatora klienta metadanych.
Wstrzymuj, reaktywuj i anuluj działania dla obsługiwanych stanów subskrypcji.

E-mail, identyfikator klienta, pliki PDF, metody płatności, klucze licencyjne, zmiana planu i W pierwszej wersji portalu nie można zmieniać przepływów wznawiania anulowanej subskrypcji.