Partner API

Partner API je namenjen bankam, botom, ploščam preprodajalcev, notranjim sistemom za zagotavljanje in drugim zaupanja vrednim integracijam med strežniki. Različica 10.5.0 je prva pogodba za stroj, pripravljen za banko.

Osnovni URL

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

Preverjanje pristnosti

Authorization: Bearer mg_partner_...

Vsak odgovor je JSON, vključno z 404, 405, 429, in 500, in vključuje X-Request-ID. Uporaba odzivov Cache-Control: no-store; partnerski gostitelj ne uporablja PHP sej brskalnika. Vsi zunanji časovni žigi so UTC RFC3339 (YYYY-MM-DDTHH:MM:SSZ).

Vse POST, PATCH, in DELETE operacije zahtevajo edinstveno Idempotency-Key glava. Model Gate hrani šifriran rezultat 7 dni, tako da ponovni poskus iste zahteve vrne izvirni rezultat brez ponovne izvedbe mutacije. Ponovna uporaba istega ključa za drugo metodo/pot/telo vrne HTTP 409.

Zahteve za partnerje so zaščitene z omejitvijo cene na minuto na ravni računa, ki jo konfigurira PARTNER_API_RATE_LIMIT_PER_MINUTE (privzeto 600). Odzivi vključujejo X-RateLimit-Limit, X-RateLimit-Remaining, in X-RateLimit-Reset; HTTP 429 vključuje tudi Retry-After.

Ustvarite ali ponovno ustvarite ključ Partner API v profilu Model Gate. Celoten žeton nosilca je prikazan samo enkrat pri ustvarjanju/rotaciji in Model Gate shrani samo svojo zgoščeno vrednost SHA-256 in prikazno predpono. Takoj shranite žeton v upravitelju skrivnosti na strani strežnika; če se izgubi, ga obrnite.

Profil ima ločeno Seznam dovoljenih naslovov API IP. Če ni prazen, morajo zahteve Partner API izvirati iz dovoljenega natančnega naslova IPv4/IPv6 ali predpone CIDR. Pravila API-ja za poslovno organizacijo veljajo poleg osebnega pravila. Vir, ki ga kateri koli od učinkovitih seznamov dovoljenih zavrne, prejme HTTP 403 z error.type = ip_not_allowed.

Za poslovne račune je poverilnica Partner API na voljo samo preverjenemu lastniku organizacije. Voditelji zaposlenih in dodeljene poslovne poverilnice se upravljajo v spletni plošči, kjer je mogoče preveriti dovoljenja za skupinsko izvajanje. Poslovni ključi, ki jih ustvarijo partnerji, torej uporabljajo lastnika kot lastnika obračunavanja in glavnega poverilnice. A priloženo group_id mora poimenovati aktivno skupino v lasti računa; neznana/zamrznjena skupina je zavrnjena s HTTP 422 namesto tihega ustvarjanja nezdruženega ključa.

Decimalne vrednosti

Finančna polja in polja uporabe so vedno nizi JSON:

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

Uporabi decimalno aritmetiko poljubne natančnosti. Nikoli ne pretvorite teh vrednosti v float.

Zmogljivosti

• Ustvarite, navedite, posodobite, zavrtite, zamrznite, odmrznite in izbrišite ključe API.
• Konfigurirajte vrednotenje uporabe po ključu.
• Ustvarite in upravljajte skupine.
• Premikanje tipk med skupinami.
• Preberite uporabo ključa in skupine.
• Preberite dokončano zgodovino zahtev za ključ v vrstnem redu ob zaključku z 1–100 stranmi vrstic in razčlenitvijo žetona/cene. Podrobna zgodovina zahtev se vroče hrani za API_REQUESTS_HOT_RETENTION_DAYS (privzeto 7 dni); dolgoročnejša finančna uskladitev uporablja dnevnik transakcij stanja.
• Preberite stanje na tekočem računu in transakcije stanja na računu s paginacijo kazalca.
• Preberite revizijske dogodke upravljanja partnerjev s paginacijo kazalca.
• Rezultati anketiranja asinhronega sklepanja.

glej vseh Partner API končnih točk za popolne primere zahtev in odgovorov.

Nedavni zapisi zgodovine zahtev vključujejo principal_user_id ko poverilnica še vedno obstaja, ločeno od lastnika podjetja, ki obračunava.

Strojno berljiva pogodba

Pogodba OpenAPI 3.1 je poslana z vsako izdajo kot resources/contracts/partner-api.openapi.yaml. Obravnavajte jo skupaj s temi Partner API stranmi kot pogodbo o integraciji banke. Neznana polja JSON in neznani poizvedbeni parametri so zavrnjeni namesto tiho prezrti.