Dokumentacja API

Uwierzytelnianie

Nagłówki kluczy API, obsługa sekretów, uprawnienia i rotacja.

Model poświadczeń

Klucze MakePay API są tworzone z obszaru programistycznego MakeCrypto i przypisane do jednego zespołu. Każdy klucz ma identyfikator klucza publicznego i sekret. Sekret jest przechowywany jako skrót i jest pokazywany tylko raz po utworzeniu.

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.

Tworzenie klucza API

Zalogowani użytkownicy z uprawnieniami settings.manage mogą tworzyć klucze za pośrednictwem portalu lub poprzez ścieżkę integracji zespołu.

Użyj ścieżki wykrywania zarejestrowanej firmy, gdy narzędzie portalu musi wyświetlić zespoły dostępne dla bieżącego użytkownika:

GET /api/partner/v1/companies

Zwrócona firma id jest używana wyłącznie do tras pulpitu nawigacyjnego/zarządzania kluczami. Trasy płatności MakePay serwer-serwer rozwiązują firmę na podstawie klucza API, więc nie wymagają identyfikatora firmy w adresie URL.

POST /api/partner/v1/companies/{companyId}/integrations
Content-Type: application/json

{
  "name": "Production backend",
  "appSlug": "makepay",
  "allowedOrigins": ["https://merchant.example"]
}

Odpowiedź zawiera integration.key_id, integration.partner_id i integration.keySecret. Natychmiast zapisz keySecret.

Uwierzytelnianie żądań

Wyślij identyfikator klucza i sekret jako nagłówki do tras łącza płatniczego MakePay.

x-makecrypto-key-id: mk_makepay_...
x-makecrypto-key-secret: mksec_...

API akceptuje także zalogowane sesje przeglądarki MakeCrypto dla wywołań interfejsu użytkownika portalu. Integracje serwer-serwer powinny wykorzystywać nagłówki kluczy, aby żądania były niezależne od sesji użytkownika.

Uprawnienia

Trasy odczytu akceptują dowolnego zalogowanego członka zespołu lub ważny klucz MakePay API. Mutowanie tras wymaga settings.manage dla sesji przeglądarki. Klucze API są traktowane jako dane uwierzytelniające zaufanego serwera dla zespołu będącego ich właścicielem, dlatego należy je ograniczać do kontrolowanych przez siebie systemów zaplecza.

Rotacja i uchylenie

Utwórz nowy klucz, wdróż go na swoim backendzie, a następnie wyłącz lub usuń stary klucz w obszarze programisty MakeCrypto. Istniejące tajemnice nie mogą zostać ponownie ujawnione po stworzeniu.

Błędy uwierzytelniania

401 Unauthorized oznacza, że żądanie nie ma ważnej sesji ani prawidłowej pary kluczy API.
401 Invalid MakePay API credentials oznacza, że identyfikator klucza, klucz tajny, zakres produktu lub stan włączenia nie są zgodne.
403 Forbidden oznacza, że zalogowany użytkownik nie może uzyskać dostępu do zespołu lub nie ma wymaganych uprawnień.
404 API key not found jest zwracany przez trasy zarządzania kluczami, jeśli wybrany partnerId nie istnieje dla zespołu.