Partner API

A Partner API bankoknak, robotoknak, viszonteladói paneleknek, belső kiépítési rendszereknek és más megbízható szerver-szerver integrációknak készült. A 10.5.0-s verzió az első banki használatra kész gépszerződés.

Alap URL

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

Hitelesítés

Authorization: Bearer mg_partner_...

Minden válasz JSON, beleértve 404, 405, 429, és 500, és tartalmazza X-Request-ID. Válaszok használata Cache-Control: no-store; a Partner gazdagép nem használ böngésző PHP szekciókat. Minden külső időbélyeg UTC RFC3339 (YYYY-MM-DDTHH:MM:SSZ).

Minden POST, PATCH, és DELETE műveletekhez egyedire van szükség Idempotency-Key fejléc. A Model Gate 7 napig megőrzi a titkosított eredményt, így ugyanazon kérés újrapróbálkozása az eredeti eredményt adja vissza anélkül, hogy újra végrehajtaná a mutációt. Ha ugyanazt a kulcsot használja egy másik metódushoz/útvonalhoz/törzshöz, akkor a HTTP-t adja vissza 409.

A partnerkérelmeket egy fiókszintű percdíj-korlát védi, amelyet a PARTNER_API_RATE_LIMIT_PER_MINUTE (alapértelmezett 600). A válaszok közé tartozik X-RateLimit-Limit, X-RateLimit-Remaining, és X-RateLimit-Reset; HTTP 429 is tartalmazza Retry-After.

Hozza létre vagy generálja újra a Partner API kulcsot a Model Gate profilban. A teljes hordozójogkivonat csak egyszer jelenik meg generálás/rotáció során, és a Model Gate csak az SHA-256 hash-jét és egy megjelenítési előtagot tárolja. Mentse el azonnal a tokent a szerveroldali titkos kezelőben; ha elveszett, forgassa el.

A profilnak külön van API IP engedélyezési lista. Ha nem üres, a Partner API kérésnek egy engedélyezett pontos IPv4/IPv6-címről vagy CIDR-előtagról kell származnia. Az üzleti szervezet API-szabályai a személyes szabály mellett érvényesek. Az egyik hatékony engedélyezési lista által elutasított forrás HTTP-t kap 403 -vel error.type = ip_not_allowed.

Vállalati fiókok esetén a Partner API hitelesítési adatok csak az ellenőrzött szervezettulajdonos számára érhetők el. Az alkalmazottak megbízói és a delegált üzleti hitelesítő adatok hozzárendelése a webpanelen kezelhető, ahol a csoportvégrehajtási engedélyek érvényesíthetők. A partner által létrehozott üzleti kulcsok ezért a tulajdonost számlázási tulajdonosként és hitelesítési megbízóként is használják. Egy mellékelt group_id meg kell neveznie a fiókhoz tartozó aktív csoportot; egy ismeretlen/lefagyott csoport HTTP-vel elutasításra kerül 422 ahelyett, hogy csendben létrehozna egy csoportosítatlan kulcsot.

Tizedes értékek

A pénzügyi és használati mezők mindig JSON-karakterláncok:

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

Használjon tetszőleges pontosságú decimális aritmetikát. Soha ne alakítsa át ezeket az értékeket float.

Képességek

• API-kulcsok létrehozása, listázása, frissítése, elforgatása, lefagyasztása, rögzítésének feloldása és törlése.
• Kulcsonkénti használati értékelés konfigurálása.
• Csoportok létrehozása és kezelése.
• A gombok mozgatása a csoportok között.
• Olvassa el a kulcs- és csoporthasználatot.
• Olvassa el a kulcs végleges kérelmeinek előzményeit a befejezési idő sorrendjében 1–100 oldalas oldallal és token/ár lebontással. A részletes kérelmek előzményei folyamatosan őrződnek a következőnél API_REQUESTS_HOT_RETENTION_DAYS (alapértelmezett 7 nap); a hosszabb távú pénzügyi egyeztetés az egyenleg tranzakciós naplót használja.
• Folyószámla-egyenleg és számlaegyenleg-tranzakciók olvasása kurzorlapozással.
• Olvassa el a partnerkezelési audit eseményeit a kurzor oldalszámozásával.
• Lekérdezés aszinkron következtetés eredményei.

Lásd mind a Partner API végpont teljes kérés- és válaszpéldákért.

A legutóbbi kéréstörténeti rekordok közé tartozik principal_user_id amikor a megbízói megbízó még mindig létezik, külön a vállalati számlázási tulajdonostól.

Géppel olvasható szerződés

Az OpenAPI 3.1-szerződést minden kiadáshoz a következő néven szállítjuk resources/contracts/partner-api.openapi.yaml. Kezelje ezekkel a Partner API oldalakkal együtt a banki integrációs szerződésként. Az ismeretlen JSON-mezők és az ismeretlen lekérdezési paraméterek figyelmen kívül hagyása helyett elutasításra kerülnek.