Partner API

Číslo {0} je určené pre banky, roboty, panely predajcov, interné systémy poskytovania služieb a ďalšie dôveryhodné integrácie server-to-server. Verzia 10.5.0 je prvou zmluvou o automate pripravenom na banku.

Základná adresa URL

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

Autentifikácia

Authorization: Bearer mg_partner_...

Každá odpoveď je JSON, vrátane 404, 405, 429a 500a zahŕňa X-Request-ID. Použitie odpovedí Cache-Control: no-store; partnerský hostiteľ nepoužíva relácie PHP prehliadača. Všetky externé časové pečiatky sú UTC RFC3339 (YYYY-MM-DDTHH:MM:SSZ).

Všetky POST, PATCHa DELETE operácie vyžadujú jedinečné Idempotency-Key hlavička. Model Gate uchováva zašifrovaný výsledok 7 dní, takže opakovaný pokus o rovnakú požiadavku vráti pôvodný výsledok bez opätovného vykonania mutácie. Opätovné použitie rovnakého kľúča pre inú metódu/cestu/telo vráti HTTP 409.

Žiadosti partnerov sú chránené limitom sadzby za minútu na úrovni účtu, ktorý nakonfiguroval PARTNER_API_RATE_LIMIT_PER_MINUTE (predvolené 600). Odpovede zahŕňajú X-RateLimit-Limit, X-RateLimit-Remaininga X-RateLimit-Reset; HTTP 429 tiež zahŕňa Retry-After.

Vytvorte alebo vygenerujte kľúč Partner API v profile brány modelu. Kompletný token nosiča sa pri generovaní/rotácii zobrazuje iba raz a Model Gate ukladá iba svoj hash SHA-256 plus predponu zobrazenia. Ihneď uložte token vo svojom správcovi tajných informácií na strane servera; ak sa stratí, otočte ho.

Profil má samostatný Zoznam povolených IP adries API. Ak nie je prázdny, požiadavky Partner API musia pochádzať z povolenej presnej adresy IPv4/IPv6 alebo predpony CIDR. Okrem osobného pravidla platia aj pravidlá rozhrania API obchodnej organizácie. Zdroj odmietnutý jedným z účinných zoznamov povolených prijíma HTTP 403 s error.type = ip_not_allowed.

Pre firemné účty je poverenie Partner API dostupné iba pre overeného vlastníka organizácie. Zástupcovia zamestnancov a delegované priradenie obchodných poverení sa spravujú na webovom paneli, kde možno overiť povolenia na vykonávanie skupiny. Obchodné kľúče vytvorené partnerom preto používajú vlastníka ako vlastníka fakturácie aj ako príkazcu poverenia. A dodávané group_id musí pomenovať aktívnu skupinu vlastnenú účtom; neznáma/zamrznutá skupina je odmietnutá pomocou protokolu HTTP 422 namiesto tichého vytvárania nezoskupeného kľúča.

Desatinné hodnoty

Finančné polia a polia použitia sú vždy reťazce JSON:

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

Použite ľubovoľne presnú desatinnú aritmetiku. Tieto hodnoty nikdy neprevádzajte na float.

Schopnosti

• Vytvárajte, vypisujte, aktualizujte, otáčajte, zmrazujte, rozmrazujte a vymažte kľúče API.
• Nakonfigurujte hodnotenie využitia podľa kľúča.
• Vytvárajte a spravujte skupiny.
• Presúvajte klávesy medzi skupinami.
• Čítanie kľúča a používania skupiny.
• Prečítajte si dokončenú históriu žiadostí o kľúč v poradí podľa času dokončenia s 1 až 100 riadkovými stránkami a rozpisom tokenov/ceny. Podrobná história žiadostí sa uchováva počas prevádzky API_REQUESTS_HOT_RETENTION_DAYS (predvolene 7 dní); pri dlhodobejšom finančnom vyrovnaní sa používa denník bilančných transakcií.
• Čítajte zostatok na bežnom účte a transakcie zostatku na účte pomocou kurzorového stránkovania.
• Prečítajte si udalosti auditu správy partnera so stránkovaním kurzora.
• Výsledky asynchrónneho odvodzovania prieskumu.

Pozri všetkých Partner API koncových bodov pre úplné príklady žiadostí a odpovedí.

Nedávne záznamy histórie žiadostí zahŕňajú principal_user_id keď poverovací príkaz stále existuje, oddelene od vlastníka fakturácie spoločnosti.

Strojovo čitateľná zmluva

Zmluva OpenAPI 3.1 sa dodáva s každým vydaním ako resources/contracts/partner-api.openapi.yaml. Považujte to spolu s týmito stránkami Partner API za zmluvu o integrácii banky. Neznáme polia JSON a neznáme parametre dopytu sa radšej odmietnu ako v tichosti ignorujú.