Partner API

Partner API е предназначен за банки, ботове, панели на дистрибутори, системи за вътрешно осигуряване и други надеждни интеграции между сървъри. Версия 10.5.0 е първият готов за банка договор за машина.

Основен URL адрес

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

Удостоверяване

Authorization: Bearer mg_partner_...

Всеки отговор е JSON, включително 404, 405, 429, и 500, и включва X-Request-ID. Използване на отговорите Cache-Control: no-store; Партньорският хост не използва PHP сесии на браузъра. Всички външни времеви клейма са UTC RFC3339 (YYYY-MM-DDTHH:MM:SSZ).

Всички POST, PATCH, и DELETE операции изискват уникален Idempotency-Key заглавка. Model Gate съхранява криптирания резултат в продължение на 7 дни, така че повторен опит на същата заявка връща оригиналния резултат, без да извършва мутацията отново. Повторното използване на същия ключ за различен метод/път/тяло връща HTTP 409.

Заявките за партньори са защитени от ограничение на цената на минута на ниво акаунт, конфигурирано от PARTNER_API_RATE_LIMIT_PER_MINUTE (по подразбиране 600). Отговорите включват X-RateLimit-Limit, X-RateLimit-Remaining, и X-RateLimit-Reset; HTTP 429 също включва Retry-After.

Създайте или генерирайте отново ключ Partner API в профила на Model Gate. Пълният токен на носител се показва само веднъж при генериране/завъртане и Model Gate съхранява само своя SHA-256 хеш плюс префикс за показване. Запазете токена незабавно във вашия мениджър на секрети от страната на сървъра; ако се загуби, завъртете го.

Профилът има отделен API списък с разрешени IP адреси. Когато не е празно, Partner API заявките трябва да произхождат от позволен точен IPv4/IPv6 адрес или CIDR префикс. Правилата на API за бизнес организация се прилагат в допълнение към персоналното правило. Източник, отхвърлен от някой от ефективните разрешени списък, получава HTTP 403 с error.type = ip_not_allowed.

За бизнес акаунти идентификационните данни Partner API са достъпни само за проверения собственик на организация. Директорите на служителите и делегираното присвояване на идентификационни данни за бизнес се управляват в уеб панела, където разрешенията за групово изпълнение могат да бъдат валидирани. Поради това създадените от партньори бизнес ключове използват собственика както като собственик на таксуване, така и като принципал на идентификационни данни. A доставено group_id трябва да посочи активна група, притежавана от акаунта; неизвестна/замразена група е отхвърлена с HTTP 422 вместо безшумно създаване на негрупиран ключ.

Десетични стойности

Финансовите полета и полетата за използване винаги са JSON низове:

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

Използвайте десетична аритметика с произволна точност. Никога не преобразувайте тези стойности в float.

Възможности

• Създавайте, изброявайте, актуализирайте, завъртайте, замразявайте, размразявайте и изтривайте API ключове.
• Конфигуриране на оценка на използването на ключ.
• Създавайте и управлявайте групи.
• Премествайте клавиши между групите.
• Прочетете използването на ключ и група.
• Прочетете финализираната история на заявките за ключ в крайния ред с 1–100 редови страници и разбивка на жетон/цена. Подробната хронология на заявките се съхранява горещо за API_REQUESTS_HOT_RETENTION_DAYS (по подразбиране 7 дни); по-дългосрочното финансово съгласуване използва дневника на балансовите транзакции.
• Прочетете текущото салдо по сметката и транзакциите по салдото по сметката с пагинация на курсора.
• Прочетете събития за одит на управление на партньори с пагиниране на курсора.
• Резултати от асинхронно извеждане на анкета.

Вижте всички Partner API крайни точки за пълни примери за заявки и отговори.

Скорошните записи в историята на заявките включват principal_user_id когато принципалът на идентификационните данни все още съществува, отделно от собственика на фактурирането на компанията.

Машинно четим договор

Договорът за OpenAPI 3.1 се доставя с всяка версия като resources/contracts/partner-api.openapi.yaml. Третирайте го заедно с тези Partner API страници като договор за интегриране на банката. Неизвестните JSON полета и неизвестните параметри на заявката се отхвърлят, вместо да се игнорират тихо.