Partner API

Číslo {0} je určeno pro banky, roboty, panely prodejců, interní zřizovací systémy a další důvěryhodné integrace server-to-server. Verze 10.5.0 je první smlouvou o stroji připraveném pro banku.

Základní URL

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

Autentizace

Authorization: Bearer mg_partner_...

Každá odpověď je JSON, včetně 404, 405, 429a 500a zahrnuje X-Request-ID. Použití odpovědí Cache-Control: no-store; partnerský hostitel nepoužívá relace PHP prohlížeče. Všechna externí časová razítka jsou UTC RFC3339 (YYYY-MM-DDTHH:MM:SSZ).

Vše POST, PATCHa DELETE operace vyžadují jedinečné Idempotency-Key záhlaví. Model Gate uchovává zašifrovaný výsledek po dobu 7 dnů, takže opakovaný pokus o stejný požadavek vrátí původní výsledek bez opětovného provedení mutace. Opětovné použití stejného klíče pro jinou metodu/cestu/tělo vrátí HTTP 409.

Požadavky partnerů jsou chráněny limitem sazby za minutu na úrovni účtu, který nakonfiguroval PARTNER_API_RATE_LIMIT_PER_MINUTE (výchozí 600). Odpovědi zahrnují X-RateLimit-Limit, X-RateLimit-Remaininga X-RateLimit-Reset; HTTP 429 také zahrnuje Retry-After.

Vytvořte nebo vygenerujte klíč Partner API v profilu brány modelu. Úplný token nositele je zobrazen pouze jednou při generování/rotaci a Model Gate ukládá pouze svůj hash SHA-256 plus předponu zobrazení. Okamžitě uložte token ve správci tajných informací na straně serveru; pokud se ztratí, otočte jej.

Profil má samostatný Seznam povolených IP adres API. Pokud pole není prázdné, požadavky Partner API musí pocházet z povolené přesné adresy IPv4/IPv6 nebo prefixu CIDR. Kromě osobního pravidla platí pravidla API obchodní organizace. Zdroj odmítnutý některým z účinných seznamů povolených přijímá HTTP 403 s error.type = ip_not_allowed.

U firemních účtů je pověření Partner API dostupné pouze ověřenému vlastníkovi organizace. Zaměstnanci a přidělení delegovaných obchodních pověření se spravují na webovém panelu, kde lze ověřit oprávnění k provádění skupiny. Obchodní klíče vytvořené partnerem proto používají vlastníka jako vlastníka fakturace i příkazce pověření. A dodáno group_id musí jmenovat aktivní skupinu vlastněnou účtem; neznámá/zmrazená skupina je odmítnuta pomocí HTTP 422 namísto tichého vytváření neseskupeného klíče.

Desetinné hodnoty

Pole Finance a využití jsou vždy řetězce JSON:

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

Použijte desetinnou aritmetiku s libovolnou přesností. Tyto hodnoty nikdy nepřevádějte na float.

Schopnosti

• Vytvářejte, vypisujte, aktualizujte, otáčejte, zmrazujte, uvolňujte a mažte klíče API.
• Nakonfigurujte hodnocení využití podle klíče.
• Vytvářejte a spravujte skupiny.
• Přesouvání kláves mezi skupinami.
• Čtení klíče a použití skupiny.
• Přečtěte si finalizovanou historii požadavků na klíč v pořadí podle času dokončení s 1–100 řádkovými stránkami a rozpisem tokenů/cen. Podrobná historie požadavků je uchovávána za provozu API_REQUESTS_HOT_RETENTION_DAYS (výchozí 7 dní); dlouhodobější finanční odsouhlasení používá deník transakcí zůstatků.
• Číst aktuální stav účtu a transakce zůstatku účtu pomocí kurzorového stránkování.
• Přečtěte si události auditu správy partnerů se stránkováním kurzoru.
• Výsledky asynchronního odvození dotazování.

Vidět všech Partner API koncových bodů pro úplné příklady žádostí a odpovědí.

Mezi nedávné záznamy historie požadavků patří principal_user_id když pověřovací příkaz stále existuje, odděleně od vlastníka fakturace společnosti.

Strojově čitelná smlouva

Smlouva OpenAPI 3.1 je dodávána s každým vydáním jako resources/contracts/partner-api.openapi.yaml. Považujte to spolu s těmito stránkami Partner API za smlouvu o integraci banky. Neznámá pole JSON a neznámé parametry dotazu jsou odmítnuty, nikoli tiše ignorovány.