Головна
Инструкция по взаимодействию с API
Обмен данными с учетными системами заказчиков может выполняться при помощи API.
Взаимодействие с API осуществляется по протоколу HTTP методом POST (если не оговорено иное) на URL вида http://merchik.com.ua/api/{module}/{action} . Результат ответа на запрос возвращается в формате JSON.
В случае возникновения ошибки во время выполнения запроса в результате всегда будет сгенерировано поле error.
В каждом запросе обязательно передаются параметры Вашей учетной записи
Параметры авторизации, передаваемые в каждом запросе:
Авторизация: login - Ваш логин в системе (ФИО сотрудника) [обязательно] pass - Ваш пароль в системе [обязательно]
Пример скрипта для работы с API на PHP
Получение данных по фото отчетности
URL: http://merchik.com.ua/api/images/get HTTP method: POST (рекомендуется) / GET (допускается)
Параметры, передаваемые в запросе:
Фильтры: merchik_id - код сотрудника, загрузившего фотоотчет [опционально] date_from - дата начала в формате YYYY-MM-DD (например 2014-03-01) [обязательно] date_to - дата окончания в формате YYYY-MM-DD (например 2014-03-10) [обязательно] addr_id - код адреса (или перечисление нескольких адресов через символ запятой) [опционально] addr_city_id - код города [опционально] addr_region_id - код области [обязательно] addr_tp_id - код торговой сети [опционально]
Ответ на запрос в формате JSON:
list - массив данных с перечислением фотоотчетов формат массива list: ID - уникальный номер фотоотчета dt - дата фотоотчета в формате YYYY-MM-DD addr_id - код адреса, по которому был размещен фотоотчет merchik_id - код сотрудника, разместившего фотоотчет region - наименование области city - наименование города addr - наименование адреса tp - наименование торговой сети url - прямой URL на изображение фотоотчета
Получение списка адресов
URL: http://merchik.com.ua/api/addr/get HTTP method: POST (рекомендуется) / GET (допускается)
Параметры, передаваемые в запросе:
Фильтры: addr_id - код адреса (или перечисление нескольких адресов через символ запятой) [опционально] addr_city_id - код города [опционально] addr_region_id - код области [обязательно] addr_tp_id - код торговой сети [опционально]
Ответ на запрос в формате JSON:
list - массив данных с перечислением адресов формат массива list: ID - уникальный код адреса city - наименование города city_id - код города region - наименование области region_id - код области addr - наименование адреса tp - наименование торговой сети tp_id - код торговой сети
Получение данных по деталезированной отчетности
URL: http://merchik.com.ua/api/report/get HTTP method: POST (рекомендуется) / GET (допускается)
Параметры, передаваемые в запросе:
Фильтры: merchik_id - код сотрудника, составившего отчет [опционально] date_from - дата начала в формате YYYY-MM-DD (например 2014-03-01) [обязательно] date_to - дата окончания в формате YYYY-MM-DD (например 2014-03-10) [обязательно] addr_id - код адреса (или перечисление нескольких адресов через символ запятой) [опционально] addr_city_id - код города [опционально] addr_region_id - код области [обязательно] addr_tp_id - код торговой сети [опционально] otchet_id - код деталезированного отчета [опционально]
Ответ на запрос в формате JSON:
list - массив данных с перечислением позиций деталезированного отчета формат массива list: client_id - код клиента addr_id - код адреса, по которому был размещен деталезированный отчет merchik_id - код сотрудника, разместившего деталезированный отчет region - наименование области city - наименование города addr - наименование адреса tp - наименование торговой сети tovar_id - код товара tovar_nm - наименование товара manufacturer_id- код производителя товара manufacturers_nm - наименование производителя товара otchet_dt - дата деталезированного отчета otchet_num - наименование деталезированного отчета otchet_id - номер деталезированного отчета price_vitrina - Цена товара на витрине ТТ faces_num - Количество фейсов faces_starsh - Старший фейс expire_date - Дата окончания срока годности price_min - Минимальная рекомендованная цена price_max - Максимальная рекомендованная цена return_amount - Объем возврата tovar_num - Количество товара на витрине sell_amount - Объем поднятого товара oborotved_num - Остаток товара по учету notes - Примечания