Partner API

Partner API jest przeznaczony dla banków, botów, paneli sprzedawców, wewnętrznych systemów zaopatrzenia i innych zaufanych integracji serwer-serwer. Wersja 10.5.0 jest pierwszą umową maszynową gotową do pracy w banku.

Bazowy adres URL

https://p-api.model-gate.com

Uwierzytelnianie

Authorization: Bearer mg_partner_...

Każda odpowiedź to JSON, w tym 404, 405, 429, I 500i obejmuje X-Request-ID. Odpowiedzi używają Cache-Control: no-store; host partnera nie korzysta z sesji PHP przeglądarki. Wszystkie zewnętrzne znaczniki czasu to UTC RFC3339 (YYYY-MM-DDTHH:MM:SSZ).

Wszystko POST, PATCH, I DELETE operacje wymagają unikatu Idempotency-Key chodnikowiec. Model Gate przechowuje zaszyfrowany wynik przez 7 dni, więc ponowna próba tego samego żądania zwraca oryginalny wynik bez ponownego wykonywania mutacji. Ponowne użycie tego samego klucza dla innej metody/ścieżki/treści zwraca HTTP 409.

Żądania partnerów są chronione przez limit stawek za minutę na poziomie konta skonfigurowany przez PARTNER_API_RATE_LIMIT_PER_MINUTE (domyślny 600). Odpowiedzi obejmują X-RateLimit-Limit, X-RateLimit-Remaining, I X-RateLimit-Reset; HTTP 429 zawiera również Retry-After.

Utwórz lub wygeneruj ponownie klucz Partner API w profilu Model Gate. Kompletny token okaziciela jest wyświetlany tylko raz podczas generowania/rotacji, a Model Gate przechowuje tylko swój skrót SHA-256 plus prefiks wyświetlany. Zapisz token natychmiast w menedżerze tajnych danych po stronie serwera; jeśli zostanie zgubiony, obróć go.

Profil ma oddzielny Lista dozwolonych adresów IP interfejsu API. Jeśli nie jest pusty, żądania Partner API muszą pochodzić z dokładnie dozwolonego adresu IPv4/IPv6 lub prefiksu CIDR. Reguły interfejsu API organizacji biznesowej mają zastosowanie oprócz reguły osobistej. Źródło odrzucone przez którąkolwiek z efektywnych list dozwolonych otrzymuje protokół HTTP 403 z error.type = ip_not_allowed.

W przypadku kont firmowych dane uwierzytelniające Partner API są dostępne tylko dla zweryfikowanego właściciela organizacji. Zleceniodawcami pracowników i delegowanymi uprawnieniami biznesowymi zarządza się w panelu internetowym, gdzie można sprawdzić uprawnienia do wykonywania grup. Dlatego klucze biznesowe utworzone przez partnera korzystają z właściciela zarówno jako właściciela rozliczeń, jak i podmiotu uwierzytelniającego. Dostarczony group_id musi nazwać aktywną grupę należącą do konta; nieznana/zablokowana grupa jest odrzucana za pomocą protokołu HTTP 422 zamiast po cichu tworzyć niezgrupowany klucz.

Wartości dziesiętne

Pola finansowe i użytkowe są zawsze ciągami JSON:

{
  "spend_limit": "100.0000000000",
  "usage": "12.3456789000",
  "remaining": "87.6543211000",
  "usage_price_multiplier": "0.900000"
}

Użyj arytmetyki dziesiętnej o dowolnej precyzji. Nigdy nie konwertuj tych wartości na float.

Możliwości

• Twórz, wyświetlaj, aktualizuj, obracaj, zamrażaj, odmrażaj i usuwaj klucze API.
• Skonfiguruj wycenę użycia klucza.
• Twórz grupy i zarządzaj nimi.
• Przenieś klucze między grupami.
• Przeczytaj użycie klucza i grupy.
• Przeczytaj historię sfinalizowanych żądań klucza w kolejności według czasu zakończenia, zawierającą 1–100 stron wierszy i zestawienie tokenów/ceny. Szczegółowa historia żądań jest przechowywana na bieżąco API_REQUESTS_HOT_RETENTION_DAYS (domyślnie 7 dni); w przypadku długoterminowego uzgodnienia finansowego wykorzystuje się dziennik transakcji bilansowych.
• Czytaj saldo rachunku bieżącego i transakcje salda konta za pomocą paginacji kursora.
• Przeczytaj zdarzenia audytu zarządzania partnerami z podziałem na strony kursora.
• Sonduj wyniki wnioskowania asynchronicznego.

Widzieć wszystkie Partner API punktów końcowych aby zobaczyć pełne przykłady żądań i odpowiedzi.

Najnowsze rekordy historii żądań obejmują principal_user_id gdy podmiot uwierzytelniający nadal istnieje, niezależnie od właściciela faktury firmy.

Umowa do odczytu maszynowego

Umowa OpenAPI 3.1 jest dostarczana z każdym wydaniem jako resources/contracts/partner-api.openapi.yaml. Traktuj to razem z tymi Partner API stronami jako umowę integracji Banku. Nieznane pola JSON i nieznane parametry zapytania są odrzucane, a nie dyskretnie ignorowane.