Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
doc:dev:api:manufacturer [19.12.2016 13:01] asonkin |
doc:dev:api:manufacturer [22.10.2025 12:07] (текущий) rlysov [Пример запроса на удаление данных] |
||
|---|---|---|---|
| Строка 8: | Строка 8: | ||
| Пример запроса на получение данных о производителях: | Пример запроса на получение данных о производителях: | ||
| - | http://mycompany.virtpos.ru/api/manufacturer?apikey=MySecret&format=xml | + | https://[company].myvirtualpos.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) - код производителя, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех производителях. |
| Строка 54: | Строка 54: | ||
| Пример запроса на обновление данных о производителе: | Пример запроса на обновление данных о производителе: | ||
| - | http://mycompany.virtpos.ru/api/manufacturer/update/?apikey=MySecret&format=xml&id=1&name=NewName | + | https://[company].myvirtualpos.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 | ||
| Строка 93: | Строка 93: | ||
| Пример запроса на удаление производителя: | Пример запроса на удаление производителя: | ||
| - | http://mycompany.virtpos.ru/api/manufacturer/delete/?apikey=MySecret&format=xml&id=1 | + | https://[company].myvirtualpos.ru/api/manufacturer/delete/?apikey=MySecret&format=xml&id=1 |
| ==== Параметры запроса ==== | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - код производителя который будет удален | + | * **id** (get only) - код производителя который будет удален |