Требования и рекомендации по использованию API

При интеграции необходимо разрешить доступ из сетей клиента ко всем доменам mindbox по маске *.mindbox.ru. Большинство запросов идет на api.mindbox.ru, но могут использоваться другие поддомены.

Не допускается разрешать доступ через явное прописывание IP адресов, в которые разрешается имя api.mindbox.ru или другие поддомены mindbox.ru.
Инфраструктура платформы постоянно изменяется, и IP адреса могут быть изменены без предупреждения.

❗️

Всегда разрешайте подключение к API по доменному имени, а не IP адресу

Невыполнение этого требования может повлечь за собой нарушение работы платформы для клиента. Такие случаи не покрываются SLA.

При подключении к сервисам платформы клиент должен поддерживать протокол TLS 1.2 или выше.

🚧

Протоколы SSL 3.0, TLS 1.0, TLS 1.1 не поддерживаются

Протоколы признаны небезопасными. Поддержка прекращена 22 июня 2021 года.

Используйте стандартные библиотеки для отправки HTTP-запросов, а также работы с XML, JSON и CSV. Это поможет вам избежать многих ошибок вроде неправильной обработки спец символов.

Мы постоянно добавляем в продукт новые возможности, поэтому при обработке ответов необходимо обеспечивать forward compatibility. Обработка ответа не должна падать:
— Если появляются новые теги
— Если меняется порядок тегов

Не рекомендуем использовать XML или JSON схемы для валидации ответа сервиса. При их использовании легко нарушить forward compatibility. Лучше совмещать код чтения тегов и их проверки, чтобы проверялись только те теги, которые вы реально используете.

❗️

Запрещено обращаться к API по несуществующим путям

В случае вызовов по путям, не описанным в документации, система возвратит ошибку со статусом 404.

При большом количестве таких ошибок, IP адрес клиента будет заблокирован на минуту и получит ошибки со статусом 429.