Partner API

Partner API; bankalar, botlar, bayi panelleri, dahili provizyon sistemleri ve diğer güvenilir sunucular arası entegrasyonlar için tasarlanmıştır. Sürüm 10.5.0, Banka'ya hazır ilk makine sözleşmesidir.

Temel URL

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

Kimlik doğrulama

Authorization: Bearer mg_partner_...

Her yanıt JSON'dur; 404, 405, 429, Ve 500ve içerir X-Request-ID. Yanıt kullanımı Cache-Control: no-store; Ortak ana bilgisayar, tarayıcı PHP oturumlarını kullanmaz. Tüm harici zaman damgaları UTC RFC3339'dur (YYYY-MM-DDTHH:MM:SSZ).

Tüm POST, PATCH, Ve DELETE operasyonlar benzersiz bir deneyim gerektirir Idempotency-Key başlık. Model Gate, şifrelenmiş sonucu 7 gün boyunca saklar, böylece aynı isteğin yeniden denenmesi, mutasyonu tekrar gerçekleştirmeden orijinal sonucu döndürür. Aynı anahtarın farklı bir yöntem/yol/gövde için yeniden kullanılması HTTP sonucunu döndürür 409.

İş ortağı istekleri, hesap düzeyinde yapılandırılan dakika başına ücret sınırıyla korunur. PARTNER_API_RATE_LIMIT_PER_MINUTE (varsayılan 600). Yanıtlar şunları içerir: X-RateLimit-Limit, X-RateLimit-Remaining, Ve X-RateLimit-Reset; HTTP 429 ayrıca içerir Retry-After.

Model Kapısı profilinde Partner API anahtarını oluşturun veya yeniden oluşturun. Taşıyıcı jetonun tamamı, oluşturma/döndürme sırasında yalnızca bir kez gösterilir ve Model Gate yalnızca SHA-256 karmasını ve bir görüntüleme önekini saklar. Belirteci hemen sunucu tarafı gizli yöneticinize kaydedin; kaybolursa döndürün.

Profilin ayrı bir özelliği var API IP izin verilenler listesi. Boş olmadığında, Partner API isteklerinin izin verilen tam IPv4/IPv6 adresinden veya CIDR önekinden kaynaklanması gerekir. Kişisel kurala ek olarak ticari organizasyon API kuralları da geçerlidir. Etkin izin verilenler listesinden herhangi biri tarafından reddedilen bir kaynak HTTP alıyor 403 ile error.type = ip_not_allowed.

İşletme hesapları için Partner API kimlik bilgisi yalnızca doğrulanmış kuruluş sahibine açıktır. Çalışan sorumluları ve yetki verilen İş kimlik bilgileri ataması, grup yürütme izinlerinin doğrulanabileceği web panelinde yönetilir. Bu nedenle iş ortağı tarafından oluşturulan İşletme anahtarları, sahibini hem fatura sahibi hem de kimlik bilgisi sorumlusu olarak kullanır. Sağlanan bir group_id hesaba ait olan etkin bir gruba ad vermelidir; bilinmeyen/dondurulmuş bir grup HTTP ile reddedildi 422 sessizce gruplanmamış bir anahtar oluşturmak yerine.

Ondalık değerler

Finans ve kullanım alanları her zaman JSON dizeleridir:

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

Rastgele duyarlıklı ondalık aritmetik kullanın. Bu değerleri asla şuna dönüştürmeyin: float.

Yetenekler

• API anahtarlarını oluşturun, listeleyin, güncelleyin, döndürün, dondurun, çözün ve silin.
• Anahtar başına kullanım değerlemesini yapılandırın.
• Gruplar oluşturun ve yönetin.
• Anahtarları gruplar arasında taşıyın.
• Anahtar ve grup kullanımını okuyun.
• 1-100 satırlık sayfalar ve jeton/fiyat dökümü içeren bitiş zamanı siparişinde bir anahtar için kesinleşmiş istek geçmişini okuyun. Ayrıntılı istek geçmişi, etkin durumda tutulur API_REQUESTS_HOT_RETENTION_DAYS (varsayılan 7 gün); uzun vadeli mali mutabakat, bakiye işlem günlüğünü kullanır.
• İmleç sayfalandırması ile cari hesap bakiyesi ve hesap bakiyesi hareketlerini okuyun.
• İmleç sayfalandırmasıyla İş Ortağı yönetimi denetim etkinliklerini okuyun.
• Eşzamansız çıkarım sonuçlarını yoklayın.

Görmek Partner API uç noktanın tümü tam istek ve yanıt örnekleri için.

Son istek geçmişi kayıtları şunları içerir: principal_user_id Şirketin fatura sahibinden ayrı olarak kimlik bilgisi sorumlusu hala mevcut olduğunda.

Makine tarafından okunabilen sözleşme

OpenAPI 3.1 sözleşmesi her sürümle birlikte şu şekilde gönderilir: resources/contracts/partner-api.openapi.yaml. Bu Partner API sayfayla birlikte bunu Banka entegrasyon sözleşmesi olarak kabul edin. Bilinmeyen JSON alanları ve bilinmeyen sorgu parametreleri sessizce göz ardı edilmek yerine reddedilir.