Справочник API

Аутентификация

Заголовки API-ключей, управление секретами, разрешения и ротация.

Модель учетных данных

Ключи API MakePay создаются из области разработчика MakeCrypto и ограничены одной командой. Каждый ключ имеет публичный идентификатор и секрет. Секрет сохраняется в виде хеша и отображается только один раз после создания.

Заголовок	Значение	Примечания
`x-makecrypto-key-id`	ID ключа MakePay API	Начинается с `mk_makepay_` для платежных API MakePay.
`x-makecrypto-key-secret`	Одноразовый API secret	Показывается только при создании ключа. Храните его в серверном менеджере секретов.

Создание ключей API

Прошедшие проверку пользователи с разрешением settings.manage могут создавать ключи на портале или на пути интеграции группы.

Используйте путь обнаружения компаний для аутентифицированного пользователя, когда инструменту портала необходимо отобразить команды, доступные текущему пользователю:

GET /api/partner/v1/companies

Возвращенный корпоративный id используется только для маршрутов информационной панели и управления ключами. Маршруты оплаты между серверами MakePay определяют компанию по ключу API, поэтому им не требуется идентификатор компании в URL.

POST /api/partner/v1/companies/{companyId}/integrations
Content-Type: application/json

{
  "name": "Production backend",
  "appSlug": "makepay",
  "allowedOrigins": ["https://merchant.example"]
}

Ответ включает в себя integration.key_id, integration.partner_id и integration.keySecret. Немедленно сохраните keySecret.

Запросить аутентификацию

Отправляет идентификатор ключа и секретный ключ в виде заголовков по маршрутам платежных ссылок MakePay.

x-makecrypto-key-id: mk_makepay_...
x-makecrypto-key-secret: mksec_...

API также принимает прошедшие проверку подлинности сеансы браузера MakeCrypto для вызовов портала пользовательского интерфейса. При межсерверной интеграции следует использовать заголовки ключей, чтобы запросы не зависели от сеанса пользователя.

Разрешения

Пути чтения принимают любого аутентифицированного члена команды или действительный ключ API MakePay. Маршруты, изменяющие данные, требуют settings.manage для сеансов браузера. Ключи API рассматриваются как учетные данные доверенного сервера для команды-владельца, поэтому ограничивайте их использование внутренними системами, которые вы контролируете.

Ротация и отзыв

Создайте новый ключ, разверните его на своем сервере, а затем отключите или удалите старый ключ в области разработчика MakeCrypto. Существующие секреты не могут быть раскрыты снова после создания.

Ошибки аутентификации

401 Unauthorized означает, что запрос не имеет допустимого сеанса или действительной пары ключей API.
401 Invalid MakePay API credentials означает, что идентификатор ключа, секрет, область действия продукта или включенный статус не совпадают.
403 Forbidden означает, что прошедший проверку подлинности пользователь не может получить доступ к команде или не имеет необходимых разрешений.
404 API key not found возвращается в путях управления ключами, если выбранный partnerId не существует для команды.