REST API

О документе

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

Структура URL REST API

REST API предоставляет доступ к ресурсу (наборам данных) через URL. Для использования REST API приложение должно отправлять HTTPS запрос и обрабатывать полученный ответ. В REST API в качестве формата запроса/ответа используется формат XML и стандартный набор HTTPS-запросов: GET, POST (ниже дается описания соответствия методов и наборов данных).

URL для набора данных REST API имеет следующую структуру:

https://[account-name].maxoptra.com/rest/[api-version]/[api-name]/[object-name]/[method-name]

Часть [account-name] - это имя аккаунта, указанное в адресной строке перед .maxoptra.com.

Для платформы дистрибуции должно быть указано имя API: «distribution-api».

Текущая версия API - 2.

Например, если вы хотите использовать метод save для создания и обновления заказов в Максоптре, URL для запроса будет следующий:

https://account-name.maxoptra.com/rest/2/distribution-api/orders/save

Примечание Частота запросов по каждому API-методу имеет свои ограничения, см. раздел Ограничения запросов.