Partner API

Partner API on mõeldud pankadele, robotitele, edasimüüjate paneelidele, sisemistele varustamissüsteemidele ja muudele usaldusväärsetele serveritevahelistele integratsioonidele. Versioon 10.5.0 on esimene panga jaoks valmis masinaleping.

Baas-URL

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

Autentimine

Authorization: Bearer mg_partner_...

Iga vastus on JSON, sealhulgas 404, 405, 429ja 500ja sisaldab X-Request-ID. Vastuste kasutamine Cache-Control: no-store; partneri host ei kasuta brauseri PHP seansse. Kõik välised ajatemplid on UTC RFC3339 (YYYY-MM-DDTHH:MM:SSZ).

Kõik POST, PATCHja DELETE toimingud nõuavad ainulaadset Idempotency-Key päis. Model Gate säilitab krüptitud tulemuse 7 päeva, nii et sama päringu uuesti proovimine tagastab algse tulemuse ilma mutatsiooni uuesti läbi viimata. Sama võtme taaskasutamine erineva meetodi/tee/keha jaoks tagastab HTTP 409.

Partneritaotlused on kaitstud kontotasemel minutitariifi piiranguga, mille on konfigureerinud PARTNER_API_RATE_LIMIT_PER_MINUTE (vaikimisi 600). Vastused hõlmavad X-RateLimit-Limit, X-RateLimit-Remainingja X-RateLimit-Reset; HTTP 429 sisaldab ka Retry-After.

Looge või taaslooge mudelivärava profiilis võti Partner API. Täielikku kandemärki kuvatakse genereerimisel/pööramisel ainult üks kord ja Model Gate salvestab ainult selle SHA-256 räsi ja kuva eesliide. Salvestage token kohe oma serveripoolsesse salahaldurisse; kui see on kadunud, pöörake seda.

Profiilil on eraldi API IP-lubade loend. Kui see pole tühi, peab Partner API päring pärinema lubatud täpsest IPv4/IPv6-aadressist või CIDR-i eesliitest. Äriorganisatsiooni API reeglid kehtivad lisaks isiklikule reeglile. Kummagi tõhusa lubamisloendi poolt tagasi lükatud allikas saab HTTP 403 koos error.type = ip_not_allowed.

Ettevõttekontode puhul on mandaat Partner API saadaval ainult kinnitatud organisatsiooni omanikule. Töötajate juhte ja delegeeritud ettevõtte mandaadi määramist hallatakse veebipaneelil, kus saab valideerida grupi täitmisõigusi. Partneri loodud ärivõtmed kasutavad seega omanikku nii arveldusomanikuna kui ka mandaadi põhivarana. A tarnitud group_id peab nimetama kontole kuuluva aktiivse rühma; tundmatu/külmutatud grupp lükatakse HTTP-ga tagasi 422 selle asemel, et luua vaikselt grupeerimata võti.

Kümnendväärtused

Finants- ja kasutusväljad on alati JSON-stringid:

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

Kasutage suvalise täpsusega kümnendsüsteemi aritmeetikat. Ärge kunagi teisendage neid väärtusi float.

Võimalused

• Looge, loendage, värskendage, pöörake, külmutage, vabastage ja kustutage API võtmeid.
• Seadistage võtmekasutuse hindamine.
• Looge ja hallake rühmi.
• Klahvide liigutamine rühmade vahel.
• Lugege võtme- ja rühmakasutust.
• Lugege 1–100 rea lehekülje ja märgi/hinna jaotusega võtme lõplikku taotluste ajalugu. Üksikasjalik taotluste ajalugu säilitatakse kuumalt API_REQUESTS_HOT_RETENTION_DAYS (vaikimisi 7 päeva); pikemaajaline finantslevitus kasutab bilansi tehingute ajakirja.
• Loe arvelduskonto saldot ja kontosaldo tehinguid kursori lehekülgede vahetamisega.
• Lugege kursori lehekülgedega partnerite haldamise auditisündmusi.
• Küsitluse asünkroonsete järelduste tulemused.

Vaata kõik Partner API lõpp-punkti täielike päringu ja vastuste näidete jaoks.

Hiljutised päringuajaloo kirjed hõlmavad principal_user_id kui mandaat on endiselt olemas, eraldi ettevõtte arveldavast omanikust.

Masinloetav leping

OpenAPI 3.1 leping tarnitakse iga versiooniga kui resources/contracts/partner-api.openapi.yaml. Käsitle seda koos nende Partner API lehtedega panga integreerimislepinguna. Tundmatud JSON-väljad ja tundmatud päringuparameetrid lükatakse tagasi, mitte eiratakse vaikselt.