Aplikacje OAuth

Portal deweloperski

Twórz i zarządzaj aplikacjami partnerskimi w https://apps.makecrypto.io. Aplikacje należą do firmy MakeCrypto i definiują URI przekierowań, dozwolone zakresy OAuth, webhooks, ikona, kontakt z pomocą techniczną, polityka prywatności i warunki okazane podczas wyrażania zgody.

Każda poufna aplikacja ma sekret klienta. Sekret zostaje pokazany raz kiedy jest tworzony lub obracany, a następnie przechowywany tylko jako skrót. Aplikacje publiczne musi korzystać z PKCE i nie otrzymuje tajemnicy.

Kod autoryzacyjny z PKCE

MakeCrypto obsługuje delegowaną firmę OAuth dla aplikacji partnerskich. Rozpocznij przepływ, wysyłając użytkownika do punktu końcowego autoryzacji z dokładnym zarejestrowanym przekierowania URI i wyzwanie PKCE S256.

GET https://makecrypto.io/oauth/authorize
  ?response_type=code
  &client_id=mco_app_...
  &redirect_uri=https%3A%2F%2Fpartner.example%2Fcallback
  &scope=company%3Aread%20makepay%3Apayment-links%3Aread
  &resource=https%3A%2F%2Fmakecrypto.io%2Fapi%2Fpartner%2Fv1
  &code_challenge=BASE64URL_SHA256_VERIFIER
  &code_challenge_method=S256

Użytkownik wybiera firmę, przegląda wymagane uprawnienia i zatwierdza lub odrzuca dostęp. Jeśli zatwierdzenie się powiedzie, MakeCrypto przekierowuje z powrotem z krótkim komunikatem żył kod autoryzacyjny.

Wymień kod w punkcie końcowym tokenu. Poufni klienci uwierzytelniają się za pomocą client_secret_basic lub client_secret_post; klienci publiczni uwierzytelniają się za pomocą ich weryfikator client_id i PKCE.

POST https://makecrypto.io/oauth/token
Content-Type: application/x-www-form-urlencoded
Authorization: Basic base64(client_id:client_secret)

grant_type=authorization_code
&code=mco_code_...
&redirect_uri=https%3A%2F%2Fpartner.example%2Fcallback
&code_verifier=ORIGINAL_PKCE_VERIFIER

Tokeny dostępu to krótkotrwałe tokeny okaziciela JWT. Tokeny odświeżania obracają się co raz użycie, a ponowne użycie tokenu odświeżającego unieważnia rodzinę tokenów.

Oficjalne integracje natywne, takie jak wtyczka MakePay WordPress, nie użyj portalu dla programistów lub udostępnionego sekretu klienta. Rejestrują dla każdego sklepu instalacja publiczna w POST /oauth/native/installations, użyj dokładnego wywołania zwrotnego Dopasowanie URI i otrzymanie tokenów powiązanych z DPoP, z którymi należy wysłać Authorization: DPoP i pasujący nagłówek kontrolny DPoP.

Oficjalne SDK

Jeśli chcesz integracji po stronie serwera bez budowania, użyj oficjalnych SDK klienta HTTP, ładunki łącza płatniczego i weryfikację podpisu webhook zadrapać.

SDK	Użyj go do	Przewodnik
MakePay PHP SDK	PHP, Laravel, Symfony, niestandardowy checkout i tworzenie backendowego łącza płatniczego.	PHP SDK
MakePay NPM SDK	Backendy Node.js, Next.js, TypeScript i procedury obsługi webhook po stronie serwera.	NPM SDK

Punkty końcowe

Zamiar	Punkt końcowy
Upoważnienie	GET /oauth/authorize
Wymiana tokenów	POST /oauth/token
Unieważnienie	POST /oauth/revoke
Introspekcja	POST /oauth/introspect
Przesłane żądanie autoryzacji	POST /oauth/par
Natywna rejestracja instalacji	POST /oauth/native/installations
JWKS	GET /oauth/jwks.json
Metadane serwera autoryzacji	GET /.well-known/oauth-authorization-server
Chronione metadane zasobów	GET /.well-known/oauth-protected-resource

Zakresy

Zakres	Dostęp
company:read	Przeczytaj wybraną tożsamość firmy i podstawowe ustawienia.
wallet:balances:read	Odczyt sald portfela wybranej firmy.
wallet:activity:read	Przeczytaj portfel i aktywność rozliczeniową.
makepay:payment-links:read	Przeczytaj linki do płatności MakePay i status płatności.
makepay:payment-links:write	Twórz i aktualizuj łącza płatnicze MakePay.
makepay:customers:read	Przeczytaj zapisy klientów MakePay.
makepay:customers:write	Twórz i aktualizuj rekordy klientów MakePay.
makepay:subscriptions:read	Przeczytaj rekordy subskrypcji MakePay.
makepay:subscriptions:write	Twórz i aktualizuj subskrypcje MakePay.
makepay:settings:read	Przeczytaj ustawienia sprzedawcy MakePay i włączone zasoby.
makepay:settings:write	Zaktualizuj ustawienia sprzedawcy MakePay i konfigurację wywołania zwrotnego.
makepay:webhooks:read	Odczyt punktów końcowych MakePay webhook i dzienników dostaw.
makepay:webhooks:write	Twórz, aktualizuj, testuj i ponawiaj dostawy MakePay webhook.

Uprawnienia dotyczące trasy API

Trasa	Metoda	Wymagany zakres
/api/partner/v1/makepay/payment-links	GET	makepay:payment-links:read
/api/partner/v1/makepay/payment-links	POST	makepay:payment-links:write
/api/partner/v1/makepay/customers	GET	makepay:customers:read
/api/partner/v1/makepay/customers	POST	makepay:customers:write
/api/partner/v1/makepay/subscriptions	GET	makepay:subscriptions:read
/api/partner/v1/makepay/subscriptions	POST	makepay:subscriptions:write
/api/partner/v1/makepay/settings	GET	makepay:settings:read
/api/partner/v1/makepay/settings	PUT	makepay:settings:write
/api/partner/v1/makepay/webhook-requests	GET	makepay:webhooks:read
/api/partner/v1/companies/{id}/wallet/balances	GET	wallet:balances:read
/api/partner/v1/companies/{id}/wallet/activity	GET	wallet:activity:read

Podpisywanie Webhook

Aplikacja webhooks zawiera nagłówek makecrypto-signature ze znacznikiem czasu i Wartości podpisu v1. Sprawdź aktualność znacznika czasu, odbuduj podpisany ładunek jako timestamp.rawBody i porównaj podpis z pokazanym kluczem tajnym webhook raz podczas tworzenia lub obracania punktu końcowego.

Połączone zarządzanie aplikacjami

Zatwierdzone granty OAuth widoczne są w panelu firmowym pod adresem Integrations -> Connected apps. Administratorzy firmy mogą na koniec sprawdzić stan aplikacji dostęp i przyznane zakresy, a następnie unieważnij dostęp, gdy powinno to nastąpić w przypadku połączenia partnerskiego przestań pracować.