Организации 6
жүктеу/скачать 283.5 Kb.
|
- Бұл бет үшін навигация:
- Аутентификация и авторизация
- Получить маркер доступа
- Проверка маркера доступа
- Организации (2.6.1)
- Получение списка организаций
- Получение информации о заданной организации
- Номенклатура (меню)
- Получить дерево номенклатуры
- Получить картинку (изображение продукта)
- Создание/Изменение заказа
- Получение списка акций в заданной организации
- Ответы и коды ошибок
- Внутренние ошибки сервера
- Date Дата. Строка в формате “YYYY-MM-DD”, где YYYY - год; MM - месяц (начиная с 1 - январь); DD - день. Time
- OrganizationInfo (2.6.1)
| API
Методы Аутентификация и авторизация Получить маркер доступа Проверка маркера доступа Организации (2.6.1) Получение списка организаций Получение информации о заданной организации Номенклатура (меню) Получить дерево номенклатуры Получить картинку (изображение продукта) Заказы Создание заказа Информация о заказе Акции (2.6.1) Получение списка акций в заданной организации Ответы и коды ошибок Внутренние ошибки сервера Данные Простые типы DateTime Date Time TimeSpan Составные типы Group Product Modifer Address OrderRequest Order OrderItem OrderItemModifier Customer OrderInfo OrganizationInfo (2.6.1) SpecialInfo (2.6.1) ContactInfo (2.6.1) APIМетоды Ответы и коды ошибок Данные
МетодыПоследняя колонка указывает особые условия для поля: * - обязательное поле Аутентификация и авторизацияБазовый адрес сервиса: /api/0/auth Все методы данного сервиса работают по протоколу https. Получить маркер доступа Проверка маркера доступа Получить маркер доступаМаркер доступа выдается на фиксированный интервал времени. По умолчанию это - 15 минут. Логин и пароль на доступ к платформе и ее сервисам выдаются компанией iiko в ручном режиме. Впоследствии эта процедура будет автоматизирована. /api/0/auth/access_token?user_id={user_id}&user_secret={user_secret}
Параметры
Ответ
Пример https://iiko.net/api/0/auth/access_token?user_id=client&user_secret=secret Проверка маркера доступаВнимание: использовать только при разработке. Нельзя использовать в поставляемой версии, так как метод может быть удален в любой момент. /api/0/auth/echo?msg={msg}&access_token={accessToken} Параметры
Ответ
Организации (2.6.1)Все методы этого сервиса работают по протоколу https. Интерфейс предназначен для получения списка организаций с названиями, описаниями, логотипами, контактной информацией, адресом. Предполагаемый сценарий использования - интеграция с внешними системами, отображающими организации с доп. информацией на картах, в списках и т.п. Получение списка организаций/api/0/organization/list?access_token={accessToken}&request_timeout={requestTimeout}
Параметры
Ответ
Пример { { "organizationId":"1721531da-7ed5-4cf8-3ad1f-370031d2e6b1", “name”:”ArteFAQ”, … }, { "organizationId":"1721531da-7ed5-4cf8-3ad1f-370031d2e6b2", “name”:”DeFAQto”, … } }
Получение информации о заданной организацииВозвращает поля-описатели организации /api/0/organization/organizationId?access_token={accessToken}&request_timeout={requestTimeout}
Параметры
Ответ
Пример { "organizationId":"1721531da-7ed5-4cf8-3ad1f-370031d2e6b1", “name”:”ArteFAQ”, “description”:”Greate place to socialize and meet with ladies”, “location”:”Moscow-somewhere (ask google for geolocation and route)” }
Все методы этого сервиса работают по протоколу https. Получить дерево номенклатуры Получить картинку (изображение продукта) Получить дерево номенклатуры/api/0/nomenclature/organizationId?revision={revision} Один запрос возвращает информацию как о группах, так и о продуктах. Ревизия одна на все дерево продуктов. Метод возвращает:
Параметры
Ответ
Пример {
{ "code": null, "description": null, "id": "9fa0dd9a-03f3-4d27-b74a-500000000002", "name": "Закуски", "order": 0, "parentGroup": "9fa0dd9a-03f3-4d27-b74a-500000000001", "imageId": null }, { "code": null, "description": null, "id": "9fa0dd9a-03f3-4d27-b74a-500000000001", "name": "Основное меню", "order": 0, "parentGroup": null, "imageId": null } ], "products": [ { "code": null, "description": null, "id": "9fa0dd9a-03f3-4d27-b74a-000000000003", "name": "Рыба в кляре", "carbohydrateAmount": null, "energyAmount": null, "fatAmount": null, "fiberAmount": null, "groupdId": null, "groupModifiers": [ ],
],
],
{ "maxAmount": 1, "minAmount": 0, "modifierId": "9fa0dd9a-03f3-4d27-b74a-000000000002" } ], "price": 10.00000, "type": "good", "weight": null, "imageId": null, "isIncludedInMenu": true, "order": 0, "parentGroup": "9fa0dd9a-03f3-4d27-b74a-500000000002" }, { "code": null, "description": null, "id": "9fa0dd9a-03f3-4d27-b74a-000000000002", "name": "butter", "carbohydrateAmount": null, "energyAmount": null, "fatAmount": null, "fiberAmount": null, "groupModifiers": [ ],
],
Возвращает картинку по ее идентификатору.
Параметры
Ответ Картинка. ЗаказыСоздание\редактирование заказа Информация о заказе Создание/Изменение заказа/api/0/orders/add?access_token={accessToken}&request_timeout={requestTimeout} При создании заказа предполагается, что идентификатор задается клиентом. Если идентификатор корректен, то заказ создается с ним. Если идентификатор не корректен, то возвращается ошибка. Идентификатор пользователя позволяет выбрать уже зарегистрированного пользователя или создать нового. Если идентификатор не корректен, то возвращается ошибка.
Параметры
Ответ
Пример { "restaurantId":"1721531da-7ed5-4cf8-3ad1f-370031d2e6b1", "customer":{"id":"88529d26-efa5-48e2-af5e-96c245f62d26", "name":"Client", "phone":"Phone"}, "order":
{ "id":"76da34ed-7952-49e3-a2fa-4a0283d510b8", "phone":"Phone", "address":{"street":"Street-1", "home":"1"}, "date":"2011-09-20 18:30:00", "items": [ { "id":"040adebb-695a-4687-93bc-4ad30b370b83", "name":"Пицца", "amount":"1", "modifiers":[ { "id": "8a5b6dce-c5d1-4932-9c61-073b3dd57645", "name":"Топпинг", "amount":"3", "groupId":"35e3d0c0-cb19-4bf1-b760-fe8c0061f4d1", "groupName":"Топпинги для пиццы" } ]
] }
Информация о заказе/api/0/orders/info?access_token={accessToken}&restaurant={restaurantId}&order={orderId}& request_timeout={requestTimeout} Получение информации о предварительно созданном заказе.
Параметры
Ответ
Акции (2.6.1)Все методы этого сервиса работают по протоколу https. Получение списка акций в заданной организации/api/0/organization/organizationId/specials?access_token={accessToken}&request_timeout={requestTimeout}
Параметры
Ответ
Пример Ответы и коды ошибокДля индикации результата запроса используется HTTPстатус. Частые статусы:
Дополнительные данные об ошибке могут указываться в параметре errorType. Внутренние ошибки сервераВ качестве внутренних ошибок сервера с кодом 500 (Internal Server Error) в параметре errorType могут возвращаться следующие значения.
ДанныеПростые типыDateTimeДата и время. Строка в формате “YYYY-MM-DD hh:mm:ss”, где YYYY - год; MM - месяц (начиная с 1 - январь); DD - день; hh - час (от 00 до 23); mm - минута (от 00 до 59); ss - секунда (от 00 до 59). DateДата. Строка в формате “YYYY-MM-DD”, где YYYY - год; MM - месяц (начиная с 1 - январь); DD - день.
TimeВремя. Строка в формате “hh:mm:ss”, где hh - час (от 00 до 23); mm - минута (от 00 до 59); ss - секунда (от 00 до 59).
TimeSpanПериод времени. Строка в формате “hh:mm:ss”, где hh - часы; mm - минуты; ss - секунды.
Составные типыПоследняя колонка указывает особые условия для поля: * - обязательное поле GroupГруппа
ProductПродукт
ModiferМодификатор
AddressАдрес
OrderRequest
OrderЗаказ
OrderItemЭлемент заказа
OrderItemModifierМодификатор элемента заказа
CustomerЗаказчик
OrderInfoОписание заказа
OrganizationInfo (2.6.1)Описание организации (Ресторан, AЗС, Гостиница, ...)
SpecialInfo (2.6.1)Описание акции
ContactInfo (2.6.1)Контактная информация.
1 При реализации акции - при оплате заказа, это значение сохраняется в заказ iikoNet. В текущей реализации - для справки - URL открывает страницу с пользовательским интерфейсом iikoNet для добавления акции в кошелек пользователя. жүктеу/скачать 283.5 Kb. Достарыңызбен бөлісу:
|