V3 API
Способы вызова операций
Code
Domain API Mindbox
Это домен, по которому будет происходить обращение в API Mindbox.
Чтобы определить нужный домен для вашего проекта, сделайте следующее:
- Перейдите на сайт проекта
- Перейдите в список операций Кампании → Список кампаний → Операции
- Перейдите в любую операцию
- Нажмите «Посмотреть описание»
- Скопируйте домен из URL в спецификации

Домен для ГОСТ TLS
Помимо стандартного TLS с международными алгоритмами шифрования, Mindbox поддерживает ГОСТ TLS — TLS на российских криптографических алгоритмах.
Чтобы использовать ГОСТ TLS, отправляйте запросы на домен с префиксом gost-:
| Домен операции на проекте | Домен ГОСТ TLS |
|---|---|
https://api.mindbox.ru | https://gost-api.g.mindbox.ru |
https://api.s.mindbox.ru | https://gost-api.s.mindbox.ru |
https://api.b.mindbox.ru | https://gost-api.b.mindbox.ru |
EndpointId
Системное имя точки интеграции: сайта, мобильного приложения, кассы или другой внешней системы. Скопируйте его из настроек точки интеграции в разделе Интеграции или получите у менеджера проекта. Подробнее о создании точки интеграции — в статье Как создать и настроить точку интеграции.
Системное имя чувствительно к регистру: myshop.Website и Myshop.Website — разные имена. Передавайте его точно так, как оно записано в настройках точки интеграции. Системное имя нельзя изменить после создания точки интеграции.
В мобильных SDK этот параметр называется endpoint или endpointId, в Flutter — endpointIos и endpointAndroid.
Заголовок Authorization
- Наличие заголовка 'Authorization' зависит от операции.
- Необходимость нужно уточнить у менеджера.
- Каждому EndpointId соответствует свой secretKey, значение нужно уточнить у менеджера.
Operation
- Название операции в Майндбокс. Каждому типу действия на сайте/на кассе/мобильном приложении соответствует своя операция.
- Список операций настраивается в системе.
- Формат тела запроса и ответа, различается в зависимости от типа операции.
DeviceUUID
Обязательность нужно уточнить у менеджера
- для сайта, нужно передать DeviceUUID из куки mindboxDeviceUUID
- для Android нужно получить значение через метод SDK
subscribeDeviceUuid - для iOS нужно получить значение через метод SDK
getDeviceUUID
Формат тела запроса
В зависимости от заголовка Content-Type данные в теле запроса могут приниматься либо в формате XML, либо в формате JSON.
Тело запроса должно быть в кодировке UTF-8.
Формат тела ответа
В зависимости от заголовка Accept ответ сервиса будет либо в формате XML, либо в формате JSON.
Тело ответа возвращается в кодировке UTF-8. Ключи в ответе возвращаются в стиле написания camel case, даже если дополнительные поля имеют системное имя в верхнем регистре.