Partner API

Il Partner API è destinato a banche, bot, panel di rivenditori, sistemi di provisioning interno e altre integrazioni server-server affidabili. La versione 10.5.0 è il primo contratto macchina Bank-ready.

URL di base

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

Autenticazione

Authorization: Bearer mg_partner_...

Ogni risposta è JSON, incluso 404, 405, 429, E 500e include X-Request-ID. Utilizzo delle risposte Cache-Control: no-store; l'host partner non utilizza le sessioni PHP del browser. Tutti i timestamp esterni sono UTC RFC3339 (YYYY-MM-DDTHH:MM:SSZ).

Tutto POST, PATCH, E DELETE le operazioni richiedono un file univoco Idempotency-Key intestazione. Model Gate conserva il risultato crittografato per 7 giorni, quindi un nuovo tentativo della stessa richiesta restituisce il risultato originale senza eseguire nuovamente la mutazione. Il riutilizzo della stessa chiave per un metodo/percorso/corpo diverso restituisce HTTP 409.

Le richieste dei partner sono protette da un limite di tariffa al minuto a livello di account configurato da PARTNER_API_RATE_LIMIT_PER_MINUTE (predefinito 600). Le risposte includono X-RateLimit-Limit, X-RateLimit-Remaining, E X-RateLimit-Reset; HTTP 429 include anche Retry-After.

Crea o rigenera la chiave Partner API nel profilo Model Gate. Il token al portatore completo viene mostrato solo una volta durante la generazione/rotazione e Model Gate memorizza solo il suo hash SHA-256 più un prefisso di visualizzazione. Salva immediatamente il token nel tuo gestore segreto lato server; se viene perso, ruotarlo.

Il profilo ha un separato Lista consentita IP API. Se non è vuoto, Partner API richieste devono provenire da un indirizzo IPv4/IPv6 esatto consentito o da un prefisso CIDR. Le regole API dell'organizzazione aziendale si applicano in aggiunta alla regola personale. Una fonte rifiutata da una delle liste consentite valide riceve HTTP 403 con error.type = ip_not_allowed.

Per gli account aziendali, la credenziale Partner API è disponibile solo per il proprietario dell'organizzazione verificato. Le entità dei dipendenti e l'assegnazione delle credenziali aziendali delegate vengono gestite nel pannello Web, dove è possibile convalidare le autorizzazioni di esecuzione del gruppo. Le chiavi aziendali create dal partner utilizzano pertanto il proprietario sia come proprietario della fatturazione che come entità credenziale. Un fornito group_id deve nominare un gruppo attivo di proprietà dell'account; un gruppo sconosciuto/congelato viene rifiutato con HTTP 422 invece di creare silenziosamente una chiave non raggruppata.

Valori decimali

I campi finanziari e di utilizzo sono sempre stringhe JSON:

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

Utilizzare l'aritmetica decimale con precisione arbitraria. Non convertire mai questi valori in float.

Capacità

• Crea, elenca, aggiorna, ruota, blocca, sblocca ed elimina le chiavi API.
• Configura la valutazione dell'utilizzo per chiave.
• Creare e gestire gruppi.
• Spostare i tasti tra i gruppi.
• Leggere l'utilizzo della chiave e del gruppo.
• Leggi la cronologia delle richieste finalizzate per una chiave nell'ordine dell'ora di fine con pagine da 1 a 100 righe e suddivisione di token/prezzo. La cronologia dettagliata delle richieste viene conservata a caldo API_REQUESTS_HOT_RETENTION_DAYS (predefinito 7 giorni); la riconciliazione finanziaria a lungo termine utilizza il giornale di registrazione delle transazioni del saldo.
• Leggi il saldo del conto corrente e le transazioni del saldo del conto con l'impaginazione del cursore.
• Leggi gli eventi di controllo della gestione dei partner con l'impaginazione del cursore.
• Sondaggio dei risultati dell'inferenza asincrona.

Vedere tutti i Partner API endpoint per esempi completi di richieste e risposte.

I record recenti della cronologia delle richieste includono principal_user_id quando l'entità credenziale esiste ancora, separatamente dal titolare della fatturazione aziendale.

Contratto leggibile dalla macchina

Il contratto OpenAPI 3.1 viene fornito con ogni versione come resources/contracts/partner-api.openapi.yaml. Trattalo insieme a queste Partner API pagine come contratto di integrazione della Banca. I campi JSON sconosciuti e i parametri di query sconosciuti vengono rifiutati anziché ignorati silenziosamente.