Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
doc:dev:api:manufacturer [16.12.2016 19:48] asonkin |
doc:dev:api:manufacturer [02.06.2018 10:42] (текущий) |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| ====== API :: Manufacturer. Получение/изменение данных о производителях ====== | ====== API :: Manufacturer. Получение/изменение данных о производителях ====== | ||
| - | В системе реализован программный интерфейс для получения, добавления, изменения и удаления производителей. Данные выгружаются по http протоколу. Формат на выбор - xml или json. | + | В системе реализован программный интерфейс для получения, добавления, изменения и удаления производителей. Данные выгружаются по http протоколу. Формат на выбор - XML или JSON. |
| Строка 8: | Строка 8: | ||
| Пример запроса на получение данных о производителях: | Пример запроса на получение данных о производителях: | ||
| - | http://mycompany.virtpos.ru/api/Manufacturer?apikey=MySecret&format=xml | + | http://mycompany.virtpos.ru/api/manufacturer?apikey=MySecret&format=xml |
| ==== Параметры запроса ==== | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - код производителя, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех производителях. | + | * **id** (get only) - код производителя, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех производителях. |
| Строка 28: | Строка 28: | ||
| Ниже приведен пример ответа сервера в формате XML | Ниже приведен пример ответа сервера в формате XML | ||
| + | <file xml> | ||
| <?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| <root> | <root> | ||
| <success>1</success> | <success>1</success> | ||
| - | <type>item_group</type> | + | <type>manufacturer</type> |
| - | <count>91</count> | + | <count>2</count> |
| <manufacturers> | <manufacturers> | ||
| <manufacturer> | <manufacturer> | ||
| Строка 48: | Строка 49: | ||
| </manufacturers> | </manufacturers> | ||
| </root> | </root> | ||
| + | </file> | ||
| ===== Пример запроса на добавление/изменение данных ===== | ===== Пример запроса на добавление/изменение данных ===== | ||
| - | Пример запроса на обновление данных о производителях: | + | Пример запроса на обновление данных о производителе: |
| http://mycompany.virtpos.ru/api/manufacturer/update/?apikey=MySecret&format=xml&id=1&name=NewName | http://mycompany.virtpos.ru/api/manufacturer/update/?apikey=MySecret&format=xml&id=1&name=NewName | ||
| ==== Параметры запроса ==== | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - код товарной группы, данные которой надо обновить | + | * **id** (get only) - код производителя, данные которого нужно обновить |
| - | * **create_if_not_exist** - Если истина, то при неудачном поиске производитель будет добавлен в систему. | + | * **create_if_not_exist** (get only) - Если истина, то при неудачном поиске производитель будет добавлен в систему. |
| * Также в качестве параметров могут быть переданы все поля для производителя, на данный момент это только name | * Также в качестве параметров могут быть переданы все поля для производителя, на данный момент это только name | ||
| Строка 88: | Строка 89: | ||
| </file> | </file> | ||
| + | ===== Пример запроса на удаление данных ===== | ||
| + | |||
| + | Пример запроса на удаление производителя: | ||
| + | |||
| + | http://mycompany.virtpos.ru/api/manufacturer/delete/?apikey=MySecret&format=xml&id=1 | ||
| + | |||
| + | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| + | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| + | |||
| + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | ||
| + | |||
| + | * **id** (get only) - код производителя который будет удален | ||
| + | |||
| + | |||
| + | ==== Ответ сервера ==== | ||
| + | |||
| + | В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info. | ||
| + | |||
| + | Также возвращается id записи, которая была удалена. | ||
| + | |||
| + | |||
| + | |||
| + | ==== Пример ответа сервера ==== | ||
| + | <file xml> | ||
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
| + | <root> | ||
| + | <success>1</success> | ||
| + | <id>1</id> | ||
| + | </root> | ||
| + | </file> | ||