Различия

Показаны различия между двумя версиями страницы.

--- doc:dev:api:manufacturer [02.06.2018 07:42] – внешнее изменение
+++ doc:dev:api:manufacturer [26.09.2026 14:03] (текущий) – внешнее изменение
@@ Строка 1: / Строка 1: @@
-====== API :: Manufacturer. Получение/изменение данных о производителях ======
+====== Manufacturer. Производители ======
-В системе реализован программный интерфейс для получения, добавления, изменения и удаления производителей. Данные выгружаются по http протоколу. Формат на выбор - XML или JSON.
+Статья перенесена: [[hc:api:manufacturer]]
-===== Пример запроса на получение данных =====
-Пример запроса на получение данных о производителях:
- http://mycompany.virtpos.ru/api/manufacturer?apikey=MySecret&format=xml
-==== Параметры запроса ====
-параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
-  * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** (get only) - код производителя, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех производителях.
-==== Ответ сервера ====
-В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info
-==== Пример ответа сервера ====
-Ниже приведен пример ответа сервера в формате XML
-<file xml>
-<?xml version="1.0" encoding="UTF-8"?>
-<root>
-   <success>1</success>
-   <type>manufacturer</type>
-   <count>2</count>
-   <manufacturers>
-      <manufacturer>
-         <id>1</id>
-         <name>Газмяс</name>
-         <created_date>2015-05-15 18:21:02</created_date>
-         <last_update_date>2016-12-13 20:21:02</last_update_date>
-      </manufacturer>
-      <manufacturer>
-         <id>2</id>
-         <name>Водолей</name>
-         <created_date>2015-05-15 18:21:02</created_date>
-         <last_update_date>2015-05-15 18:21:02</last_update_date>
-      </manufacturer>
-   </manufacturers>
-</root>
-</file>
-===== Пример запроса на добавление/изменение данных =====
-Пример запроса на обновление данных о производителе:
- http://mycompany.virtpos.ru/api/manufacturer/update/?apikey=MySecret&format=xml&id=1&name=NewName
-==== Параметры запроса ====
-параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
-  * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** (get only) - код производителя, данные которого нужно обновить
-  * **create_if_not_exist** (get only) - Если истина, то при неудачном поиске производитель будет добавлен в систему.
-  * Также в качестве параметров могут быть переданы все поля для производителя, на данный момент это только name
-==== Ответ сервера ====
-В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info.
-Также возвращается id записи, которая была обновлена или добавлена.
-  * Флаг **isnew** равен "1", если запись была создана, и "0" если обновлена.
-==== Пример ответа сервера ====
-<file xml>
-<?xml version="1.0" encoding="UTF-8"?>
-<root>
-	<success>1</success>
-	<id>1</id>
-	<isnew>0</isnew>
-</root>
-</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>