Содержание
Функции ПрайМастрикс API ориентированы на то чтобы быстро выгрузить информацию о товарах.
Как настраивается API в кабинете пользователя сервиса ПрайсМатрикс?
- Перейдите в меню: Настройки -> API
- Сгенерируйте APIKey. Нажмите на кнопку сгенерировать APIKey.
На странице вы увидите ваш секретный APIKey. Он будет использоваться, чтобы получать данные из вашей кампании ПрайсМатрикс.
Вебинар (Урок) про выгрузки и API ПрайсМатрикс
32 минуты о том как работает выгрузка в ПрайсМатрикс.
Функции
CampaignDataLatestGet - Главный Прайс — Выгрузка в фиксированные форматы
Пример: https://app.price-matrix.ru/WebApi/CampaignDataLatestGet/{YourApiKey}
"Выгрузить главный прайс" вручную или по расписанию, или путем вызова извне командой API, а если выгрузка не происходила, то при вызове этого API будет возвращена ошибка.
Поэтому, сперва, в ПрайсМатрикс определите формат выгрузки ГлавногоПрайса (меню: настройки экспорта Главного прайса) и выгрузите его хотя бы вручную один раз.
Нужно определить формат выгрузки данных. Поддерживаются здесь все форматы, с которыми ПрайсМатрикс умеет работать — это CSV, XML, JSON, EXCEL, YML(Яндекс Маркет формат). Любой на ваш выбор.
Сделайте первую выгрузку данных из Главного прайса в файл нужного формата. Теперь эти данные будут доступны и в API этой команды.Когда эти три шага сделаны, то вы можете смело делать обращение к секретной ссылке, и в ответ получите бинарные данные — файл, который выгрузил ПрайсМатрикс в последний раз.
Этот файл формируется или при выгрузке вручную или при запуске выгрузки по расписанию.
Примеры выгрузки файлов из API
XML Excel CSV JSON
ExportCustom - CSV / YML Выгрузка (произвольная) (Real-time)
Update: Эта функция отключена с 2022 года. Используйтесь вместо нее exportcustom: https://price-matrix.ru/all-instructions/exportcustom
Пример: https://app.price-matrix.ru/WebApi/ExportCustom/{YourApiKey}format=yml&culture=ru
Описание работы: позволяет выгрузить в real-time данные из любого прайса ПрайсМатрикс в csv или yml формате.
В csv формате можно задать и порядок колонок и их названия.
Внутри сервиса перечислены поля и параметры, которые можно выгрузить с помощью этой команды. Важно помнить, что картинки и опции и характеристики этой командой выгрузить нельзя(Если нужны эти картинки или характеристики, то для этого есть команды CampaignDataLatestGet или SummaryReport).
Пример:
Как назвать колонку требуемым названием: для этого после названия системного необходимо требуемое вами название взять в скобки.
Допустим, что нам надо полу Sku в котором находится артикул товара выгрузить с русским названием колонки АРТИКУЛ.
Для этого поле fields надо задать так &fields=Sku(АРТИКУЛ)
Обычно эта команда используется, для того чтобы делать интеграции с другими сервисами, например, сервисом мониторинга цен либо когда достаточно передачи базовой информации о товаре.
SummaryExportLatestGet - Сводный прайс — Выгрузка
https://app.price-matrix.ru/WebApi/SummaryExportLatestGet/{YourApiKey}
Описание: Эта команда похода на CampaignDataLatestGet, а отличие заключается в том, что главный прайс выгружается вместе со связанными товарами поставщика. Здесь также выгружается последний "сводный прайс" из сервиса, который был сгенерирован или вручную или автоматической командой.
В зависимости от формата выгружаются разная полнота данных: Excel- данные минимум - XML - больше — максимум данных в JSON формате и именно его используйте для интеграции.
TaskCreate - Создание задач извне (из других программ)
https://app.price-matrix.ru/WebApi/TaskCreate/{YourApiKey}
Описание: Позволяет выполнить команду в ПрайсМатрикс из другой программы или сервиса. Например, обновить все прайсы, и пересчитать Главный Прайс. Список команд смотрите в соответствующем разделе настройки API в сервисе.
Callbacks - вызов внешних сервисов
Описание: Позволяет вызывать Web ссылки (WebRequests), на момент определенных событий в вашем аккаунте.
Callback:ExportFinished - когда завершилась команда "Выгрузка Главного прайса"
Callback:RepricingFinished - когда завершилась команда "Обновление цен и остатков в Главном прайсе"
Например, после того как ПрайсМатрикс по расписанию скачал все прайсы поставщиков и пересчитал Главный Прайс, то вызывается ваша ссылка (обработчик в 1С или в 1С-Битрикс), которая запускает скачивание вашим сайтом\системой выгрузки обновленной информации из ПрайсМатрикс.