Partner API

Partner API namijenjen je bankama, botovima, panelima preprodavača, internim sustavima za dodjelu i drugim pouzdanim integracijama između poslužitelja. Verzija 10.5.0 je prvi bankovni strojni ugovor.

Osnovni URL

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

Autentifikacija

Authorization: Bearer mg_partner_...

Svaki odgovor je JSON, uključujući 404, 405, 429, i 500, i uključuje X-Request-ID. Upotreba odgovora Cache-Control: no-store; host partnera ne koristi PHP sesije preglednika. Sve vanjske vremenske oznake su UTC RFC3339 (YYYY-MM-DDTHH:MM:SSZ).

Sve POST, PATCH, i DELETE operacije zahtijevaju jedinstvenu Idempotency-Key zaglavlje. Model Gate čuva šifrirani rezultat 7 dana tako da ponovni pokušaj istog zahtjeva vraća originalni rezultat bez ponovnog izvođenja mutacije. Ponovna upotreba istog ključa za drugu metodu/put/tijelo vraća HTTP 409.

Zahtjevi za partnere zaštićeni su ograničenjem stope po minuti na razini računa koje konfigurira PARTNER_API_RATE_LIMIT_PER_MINUTE (zadano 600). Odgovori uključuju X-RateLimit-Limit, X-RateLimit-Remaining, i X-RateLimit-Reset; HTTP 429 također uključuje Retry-After.

Stvorite ili ponovno generirajte ključ Partner API u profilu Model Gate. Potpuni token nositelja prikazuje se samo jednom prilikom generiranja/rotacije i Model Gate pohranjuje samo svoj SHA-256 hash plus prefiks prikaza. Odmah spremite token u svoj tajni upravitelj na strani poslužitelja; ako se izgubi, okrenite ga.

Profil ima zaseban API IP dopušteni popis. Kada nije prazan, Partner API zahtjevi moraju potjecati od dopuštene točne IPv4/IPv6 adrese ili CIDR prefiksa. Osim osobnog pravila primjenjuju se API pravila poslovne organizacije. Izvor odbijen na bilo kojem efektivnom popisu dopuštenih prima HTTP 403 s error.type = ip_not_allowed.

Za poslovne račune, vjerodajnica Partner API dostupna je samo potvrđenom vlasniku organizacije. Glavnima zaposlenika i delegiranom dodjelom poslovnih vjerodajnica upravlja se na web ploči, gdje se mogu potvrditi dopuštenja grupnog izvršavanja. Poslovni ključevi koje je izradio partner stoga koriste vlasnika i kao vlasnika naplate i kao principala vjerodajnice. A isporučeno group_id mora imenovati aktivnu grupu u vlasništvu računa; nepoznata/zamrznuta grupa odbijena je HTTP-om 422 umjesto tihog stvaranja negrupiranog ključa.

Decimalne vrijednosti

Financijska polja i polja korištenja uvijek su JSON nizovi:

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

Koristite decimalnu aritmetiku proizvoljne preciznosti. Nikada nemojte pretvarati ove vrijednosti u float.

Sposobnosti

• Stvorite, popišite, ažurirajte, rotirajte, zamrznite, odmrznite i izbrišite API ključeve.
• Konfigurirajte vrednovanje korištenja po ključu.
• Stvaranje i upravljanje grupama.
• Premještanje tipki između grupa.
• Pročitajte korištenje ključa i grupe.
• Pročitajte finaliziranu povijest zahtjeva za ključ u redoslijedu do kraja s 1–100 stranica redaka i raščlambom tokena/cijene. Detaljna povijest zahtjeva trenutno se čuva za API_REQUESTS_HOT_RETENTION_DAYS (zadano 7 dana); dugoročnije financijsko usklađivanje koristi dnevnik transakcije stanja.
• Čitajte stanje tekućeg računa i transakcije stanja računa pomoću paginacije pokazivača.
• Čitajte događaje revizije upravljanja partnerima s paginacijom pokazivača.
• Anketa rezultata asinkronog zaključivanja.

Vidjeti svih Partner API krajnjih točaka za potpune primjere zahtjeva i odgovora.

Nedavni zapisi povijesti zahtjeva uključuju principal_user_id kada glavni vjerodajnik još postoji, odvojeno od vlasnika naplate tvrtke.

Strojno čitljiv ugovor

Ugovor za OpenAPI 3.1 isporučuje se sa svakim izdanjem kao resources/contracts/partner-api.openapi.yaml. Tretirajte ga zajedno s ovih Partner API stranica kao ugovor o integraciji banke. Nepoznata JSON polja i nepoznati parametri upita odbijaju se umjesto tiho ignorirati.