Partner API

Partner API ir paredzēts bankām, robotprogrammatūrām, tālākpārdevēju paneļiem, iekšējām nodrošināšanas sistēmām un citām uzticamām serveru-serveru integrācijām. Versija 10.5.0 ir pirmais bankai gatavs mašīnas līgums.

Pamata URL

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

Autentifikācija

Authorization: Bearer mg_partner_...

Katra atbilde ir JSON, tostarp 404, 405, 429, un 500, un ietver X-Request-ID. Atbilžu izmantošana Cache-Control: no-store; partnera resursdators neizmanto pārlūkprogrammas PHP sesijas. Visi ārējie laikspiedoli ir UTC RFC3339 (YYYY-MM-DDTHH:MM:SSZ).

Visi POST, PATCH, un DELETE operācijām ir nepieciešama unikāla Idempotency-Key galvene. Model Gate saglabā šifrēto rezultātu 7 dienas, tāpēc, atkārtoti mēģinot to pašu pieprasījumu, tiek atgriezts sākotnējais rezultāts, atkārtoti neveicot mutāciju. Atkārtoti izmantojot to pašu atslēgu citai metodei/ceļam/ķermenim, atgriež HTTP 409.

Partneru pieprasījumus aizsargā konta līmeņa minūtes likmes ierobežojums, ko konfigurējis PARTNER_API_RATE_LIMIT_PER_MINUTE (noklusējums 600). Atbildēs ietilpst X-RateLimit-Limit, X-RateLimit-Remaining, un X-RateLimit-Reset; HTTP 429 ietver arī Retry-After.

Izveidojiet vai atkārtoti izveidojiet atslēgu Partner API Model Gate profilā. Pilns nesēja marķieris tiek parādīts tikai vienu reizi ģenerēšanas/rotācijas laikā, un Model Gate saglabā tikai tā SHA-256 jaucējkrānu un displeja prefiksu. Nekavējoties saglabājiet marķieri savā servera puses slepenajā pārvaldniekā; ja tas ir pazaudēts, pagrieziet to.

Profilam ir atsevišķs API IP atļaušanas saraksts. Ja tas nav tukšs, Partner API pieprasījumiem ir jābūt no atļautas precīzas IPv4/IPv6 adreses vai CIDR prefiksa. Uzņēmējdarbības organizācijas API noteikumi tiek piemēroti papildus personiskajai kārtulai. Avots, kuru noraidīja kāds no efektīvajiem atļaušanas sarakstiem, saņem HTTP 403 ar error.type = ip_not_allowed.

Uzņēmuma kontiem akreditācijas dati Partner API ir pieejami tikai verificētajam organizācijas īpašniekam. Darbinieku direktori un deleģētā uzņēmuma akreditācijas datu piešķiršana tiek pārvaldīti tīmekļa panelī, kur var apstiprināt grupas izpildes atļaujas. Tāpēc partneru izveidotās biznesa atslēgas īpašnieks izmanto gan norēķinu īpašnieku, gan akreditācijas datu galveno. Piegādāts group_id jānosauc kontam piederoša aktīva grupa; nezināma/iesaldēta grupa tiek noraidīta, izmantojot HTTP 422 tā vietā, lai klusībā izveidotu negrupētu atslēgu.

Decimāldaļas

Finanšu un lietojuma lauki vienmēr ir JSON virknes:

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

Izmantojiet patvaļīgas precizitātes decimālo aritmētiku. Nekad nepārvērtiet šīs vērtības uz float.

Iespējas

• Izveidot, uzskaitīt, atjaunināt, pagriezt, iesaldēt, atsaldēt un dzēst API atslēgas.
• Konfigurējiet katras atslēgas lietojuma novērtējumu.
• Izveidot un pārvaldīt grupas.
• Pārvietojiet taustiņus starp grupām.
• Izlasiet atslēgas un grupas lietojumu.
• Lasiet galīgo pieprasījumu vēsturi atslēgai pasūtījumā pēc pabeigšanas ar 1–100 rindu lapām un marķiera/cenas sadalījumu. Detalizēta pieprasījumu vēsture ir karsti saglabāta API_REQUESTS_HOT_RETENTION_DAYS (pēc noklusējuma 7 dienas); ilgāka termiņa finanšu saskaņošanai izmanto bilances darījumu žurnālu.
• Lasīt tekošā konta bilanci un konta bilances darījumus ar kursora lappušu mainīšanu.
• Izlasiet partneru pārvaldības audita notikumus ar kursora lapošanu.
• Aptaujas asinhrono secinājumu rezultāti.

Skat visi Partner API galapunkti pilnīgu pieprasījumu un atbilžu piemēriem.

Nesenie pieprasījumu vēstures ieraksti ietver principal_user_id kad akreditācijas pilnvarotājs joprojām pastāv, atsevišķi no uzņēmuma rēķina īpašnieka.

Mašīnlasāms līgums

OpenAPI 3.1 līgums tiek piegādāts kopā ar katru laidienu kā resources/contracts/partner-api.openapi.yaml. Uztveriet to kopā ar šīm Partner API lapām kā bankas integrācijas līgumu. Nezināmi JSON lauki un nezināmi vaicājuma parametri tiek noraidīti, nevis klusi ignorēti.