Авторизация и API
Вопросы, связанные с получением, использованием и проверкой API-логина iikoCloud. Ошибки авторизации, лицензии Cloud API, доступ к организациям, проблемы с ключами и правами доступа.
API логин iikoCloud используется для аутентификации и авторизации при работе с API iikoCloud. Он позволяет приложениям получать доступ к данным и функционалу системы, таким как управление заказами, меню и стоп-листам. Без API логина интеграция не будет работать, так как система не сможет идентифицировать и проверить права доступа. Для его получения необходимо зарегистрироваться в iikoCloud и создать API-ключ в настройках. Убедитесь, что у вас есть необходимые права доступа для работы с конкретными организациями в системе.
Чтобы получить API ключ для iikoCloud, войдите в свой личный кабинет iikoCloud. Перейдите в раздел «Настройки Cloud API», где вы сможете создать новый ключ (Добавить интеграцию) или скопировать существующий. Убедитесь, что у вас есть необходимые права доступа для работы с API. После создания ключа сохраните его в безопасном месте, так как он потребуется для авторизации при работе с API. Если у вас возникли трудности, обратитесь в службу поддержки iiko.
Ошибка 'Login is not authorized' возникает, когда введенный API ключ не соответствуют данным в системе iiko. Также это может произойти, если учетная запись не имеет необходимых прав для доступа к API. Проверьте правильность введенных данных и убедитесь, что пользователь имеет соответствующие права. Если проблема сохраняется, обратитесь в техническую поддержку iiko.
Эта ошибка возникает, когда срок действия лицензии на доступ к Cloud API iiko истек. Это может произойти из-за неуплаты или отсутствия продления лицензии. Чтобы решить эту проблему, необходимо обратиться в службу поддержки iiko для проверки статуса лицензии и ее обновления. После обновления лицензии доступ к API будет восстановлен. Также рекомендуется следить за сроками действия лицензии, чтобы избежать подобных ситуаций в будущем.
Вы можете проверить активность вашего API логина, отправив запрос на метод авторизации в iikoCloud API. Для этого используйте сайт apimenu.ru, который позволяет тестировать API-запросы. Введите свои API ключ и выполните запрос. Если логин активен, вы получите успешный ответ с данными вашей организации. В противном случае, система сообщит об ошибке, что указывает на проблемы с логином или правами доступа.
Проверьте, что API ключ правильно настроен в системе iiko и имеет доступ к нужной организации. Для этого зайдите в панель управления iiko и убедитесь, что ключ активирован и привязан к нужной организации. Если проблема сохраняется, воспользуйтесь сервисом apimenu.ru для получения информации о загружаемых организациях и с этими данными обратитесь в техническую поддержку iiko.
Вы можете использовать один API ключ для доступа к нескольким ресторанам, при условии, что эти рестораны принадлежат одному чейну iiko. Это позволяет упростить управление интеграциями и сократить количество необходимых ключей. Если у вас есть вопросы по настройке или проверке ключей, вы можете воспользоваться инструментом apimenu.ru для получения дополнительной информации по организациям в чейне iiko.
AccessToken используется для аутентификации при обращении к API iikoCloud. Он позволяет системе идентифицировать пользователя и проверять его права доступа к ресурсам. Без действительного AccessToken вы не сможете выполнять запросы к API, так как это обеспечит безопасность и защиту данных. Для получения AccessToken необходимо пройти процедуру авторизации, что также можно проверить с помощью инструмента apimenu.ru.
Bearer token представляет собой строку, которая используется для авторизации при обращении к API iikoCloud. Он необходим для подтверждения прав доступа к ресурсам и операциям в системе. Чтобы получить Bearer token, вам нужно пройти процесс авторизации, предоставив API ключ (API Login). После успешной авторизации вы получите токен, который можно использовать в заголовках запросов к API. Для проверки и работы с токенами можно использовать инструменты, такие как apimenu.ru.
Организации и терминалы
FAQ по работе с организациями iiko: получение списка организаций, терминалов, проблемы с доступом, несоответствие ID организации, отключённые или неактивные терминалы.
Чтобы получить список организаций через iiko API, вам необходимо авторизоваться по ключу на сайте apimenu.ru или сделать POST запрос (https://api-ru.iiko.services/api/1/organizations) к API через Postman. Использование apimenu.ru делает процесс удобным и простым, позволяя вам быстро получить все данные по организациям.
Организация может быть недоступна для вашего API логина по нескольким причинам. Во-первых, убедитесь, что такая организация действительно существует в системе iiko. Затем проверьте настройки вашего API ключа: возможно, искомая организация не привязана к этому ключу. Эти настройки можно проверить в разделе cloud API. Если вам нужно больше информации, вы можете использовать apimenu.ru как инструмент для проверки.
Ошибка ORGANIZATION_DENIED возникает, когда вы пытаетесь получить доступ к одной или нескольким организациям, которые не связаны с вашим API-ключом. Это может произойти, если вы указали неверные идентификаторы организаций в запросе. Убедитесь, что все указанные ID организаций соответствуют тем, которые доступны для вашего API-ключа. Проверьте настройки доступа и права на использование API для вашего аккаунта. Если проблема сохраняется, используйте apimenu.ru для проверки доступных организаций.
Для проверки активных терминалов в вашей организации войдите на сайт apimenu.ru и перейдите в раздел «организации». Там вы увидите полный список организаций и доступные терминалы. Напротив каждого терминала находится кнопка проверки статуса. Нажав на неё, вы получите информацию о статусе терминала: в сети или не в сети. Также можно сделать запрос через Postman к API методу (https://api-ru.iiko.services/api/1/terminal_groups/is_alive), но для этого потребуется получить токен авторизации, список организаций и терминалов, что может быть долго и неудобно. Рекомендуем использовать apimenu.ru для более простого доступа к информации.
Заказ не создаётся, если терминал выключен, так как он не способен принять и обработать поступающую информацию. Это связано с тем, что терминал должен быть активен для выполнения операций по созданию и обработке заказов. Если вы столкнулись с этой проблемой, убедитесь, что терминал включён и работает корректно. Для проверки состояния терминалов и организаций вы можете использовать инструменты, такие как apimenu.ru.
Если терминал физически выключен, при попытке создать заказ вы получите ошибку. В этом случае в ответе будет указано 'creationStatus': 'Error' и 'errorInfo' с кодом 'TerminalGroupDisabled'. Это означает, что группа терминалов отключена или не зарегистрирована. Для проверки состояния терминалов вы также можете использовать инструмент apimenu.ru.
Модификаторы
Частые вопросы и ошибки при работе с модификаторами iiko: групповые и простые модификаторы, ограничения min/max, недоступные модификаторы и ошибки выбора.
Модификаторы в iiko представляют собой групповые и простые элементы, которые позволяют пользователям настраивать состав блюд при заказе. Они могут включать в себя различные опции, такие как добавление ингредиентов или изменение характеристик блюда. Модификаторы могут иметь ограничения по количеству (min/max), что позволяет контролировать, сколько опций можно выбрать. Важно также учитывать, что некоторые модификаторы могут быть недоступны в определённых ситуациях. Для более детальной информации и проверки работы модификаторов можно использовать инструмент apimenu.ru
Ошибка 'invalid group amount' возникает, когда в заказе указано количество модификаторов, превышающее максимальное значение, установленное для группы модификаторов. Например, если для блюда разрешено выбрать до 3 модификаторов, а в заказе указано 5, система не сможет обработать такой запрос. Важно следить за тем, чтобы количество модификаторов соответствовало установленным ограничениям, иначе возникнет ошибка при создании заказа. Необходимо соблюдать эти ограничения при отправке заказа. Для проверки правильности конфигурации модификаторов вы можете использовать инструмент apimenu.ru в разделах «номенклатура» и «внешнее меню»
Групповые модификаторы в iiko дают возможность пользователю выбирать несколько вариантов из предложенных, что позволяет создавать более сложные комбинации. Простые модификаторы, в свою очередь, позволяют выбрать только один вариант из списка. Это различие важно учитывать при настройке меню и формировании заказов. Для более детальной информации о модификаторах и их настройке можно воспользоваться инструментом apimenu.ru в разделе «номенклатура» и «внешнее меню».
При получении ответа по меню в массиве товаров будут указаны данные групп модификаторов itemModifierGroups, где можно увидеть свойства minQuantity и maxQuantity. Если minQuantity больше 0, то этот модификатор является обязательным. Также простой способ проверить ограничения модификаторов — зайти в раздел «внешнее меню» сайта apimenu и открыть свойства модификаторов у любого товара. Там будут указаны самые важные свойства модификаторов, что позволит быстро получить необходимую информацию.
Создание заказов
FAQ по созданию заказов через iiko API: структура JSON, обязательные поля, типы заказов, сервисы доставки, ошибки в теле запроса и статусах заказов.
Для создания заказа через iiko API используйте метод https://api-ru.iiko.services/api/1/deliveries/create. В запросе необходимо указать заголовок Authorization с токеном, а также передать в теле запроса обязательные поля, такие как organizationId и order. Дополнительно можно указать terminalGroupId и параметры создания заказа. Тестовые заказы можно удобно делать на сайте apimenu.ru, где вы можете выбрать товары, организацию, терминал и тип доставки.
При создании заказа через iiko API необходимо указать несколько обязательных полей. К ним относятся authorization (токен доступа), organizationId (ID организации), order (объект заказа), phone (номер телефона, начинающийся с символа '+'), items (массив объектов с деталями заказа), paymentTypeKind (тип оплаты), sum (сумма к оплате) и paymentTypeId (ID типа оплаты). Все эти поля необходимы для корректной обработки заказа. Для проверки правильности формата и структуры данных можно использовать apimenu.ru раздел «отправить заказ»
Ошибка INVALID_BODY_JSON_FORMAT возникает, когда структура JSON в запросе не соответствует ожидаемому формату. Это может быть вызвано отсутствующими или лишними кавычками, запятыми или неверно закрытыми скобками. Также стоит проверить, что все строки и ключи обёрнуты в двойные кавычки и что кодировка файла соответствует UTF-8 без BOM. Чтобы исправить ошибку, проверьте JSON в любом онлайн-валидаторе, убедитесь, что все ключи и строки обёрнуты в двойные кавычки, и что последний элемент в объекте/массиве не заканчивается запятой. Рекомендуется также использовать apimenu.ru как инструмент проверки структуры JSON.
deliveries/create предназначен для создания внешнего заказа, который может быть связан с самовывозом или доставкой. В отличие от этого, order/create используется для создания заказа внутри заведения, то есть для заказов, сделанных непосредственно в стол. Эти два метода имеют разные сценарии использования и предназначены для различных типов взаимодействия с клиентами.
Тип заказа Common предназначен исключительно для создания заказов, которые обрабатываются внутри заведения. Он не подходит для сценариев, связанных с доставкой или самовывозом. При создании заказов на доставку или самовывоз необходимо использовать другие типы заказов, которые соответствуют этим процессам. Использование неправильного типа заказа может привести к ошибкам в обработке и выполнении заказов. Для проверки правильности интеграции и типов заказов вы можете воспользоваться инструментом apimenu.ru.
Доставка и время
Вопросы по доставке заказов: даты и время доставки, ASAP, CompleteBefore, TooSmallDeliveryDate, временные слоты и расписания.
Ошибка 'TooSmallDeliveryDate' возникает, когда вы пытаетесь создать заказ с датой доставки, которая уже прошла или слишком близка к текущему времени. Система iiko требует, чтобы дата доставки была установлена на будущее время, чтобы обеспечить корректное выполнение заказа. Это необходимо для того, чтобы избежать ситуаций, когда заказ не может быть выполнен в срок. Убедитесь, что вы устанавливаете дату доставки на время, которое достаточно далеко от текущего момента. Для проверки правильности установки даты доставки вы можете использовать инструменты, такие как apimenu.ru.
Система не допускает указания прошедшей даты доставки, чтобы избежать путаницы и ошибок в обработке заказов. Доставка должна быть запланирована на будущее, что обеспечивает корректное выполнение заказов и соблюдение временных рамок. Это также помогает избежать недоразумений как со стороны клиентов, так и со стороны служб доставки.
Если в заказе не указывать время, к которому должен быть готов заказ, iiko автоматически установит своё минимальное время на выполнение заказа, которое обычно составляет 1 час. Эта настройка может быть изменена в разделе меню «Доставка» → «График работы и картография». Таким образом, использование параметра ASAP позволяет учитывать стандартные временные рамки для выполнения заказов, если клиент не указывает конкретное время.
Ошибка CompleteBefore is in the past возникает, когда вы пытаетесь установить время завершения доставки, которое уже прошло относительно текущего времени. Это может произойти, если вы указали время, которое меньше текущего времени, и система не может обработать такой запрос. Для успешной доставки необходимо установить корректное время, которое будет в будущем. Рекомендуется проверять и корректировать временные параметры перед отправкой запроса.
При передаче даты и времени доставки (completeBefore) используйте формат <yyyy-MM-dd HH:mm:ss.fff>. Важно, чтобы дата и время были локальными для терминала доставки и не содержали информацию о часовом поясе. Если значение не указано, заказ считается срочным, и время доставки рассчитывается на основе настроек клиента, то есть выбирается минимально возможное время доставки. Допустимые значения для даты доставки — от текущего дня до 60 дней вперёд.
При создании заказа важно учитывать часовые пояса как клиента, так и заведения. Это позволит избежать недоразумений с временем доставки. Убедитесь, что время, указанное в заказе, соответствует часовому поясу клиента. Также рекомендуется проверить настройки времени в кассе и на сервере (сайте) через который совершается заказ.
Поле line1 предназначено для ввода основной информации об адресе. Это строка, которая может содержать такие данные, как номер дома, улица и другие ключевые элементы адреса. Обратите внимание, что это поле является необязательным, то есть может быть пустым.
При передачи адреса в формате line1 убедитесь, что организация переведена в режим пожжержки нового формата адреса.
Пример заполнения line1:
{
"address": {
"type": "city",
"line1": "Краснодар, ул. Ленина, д. 999",
"flat": "999",
"entrance": "999",
"floor": "999",
"doorphone": "999"
}
}
Оплаты и скидки
FAQ по типам оплат, скидкам и суммам заказа в iiko. Ошибки с удалёнными оплатами, отрицательными ценами, дробными значениями и настройками валют.
Ошибка 'Payment type is deleted' возникает, когда в заказе используется тип оплаты, который был удалён или отключён в системе. Это может произойти, если вы пытаетесь использовать способ оплаты, который больше не активен для вашей организации. Чтобы избежать этой ошибки, убедитесь, что вы используете только активные способы оплаты, доступные для вашей организации. Список доступных типов оплат можно найти в разделе 'Организации' на сайте. Рекомендуем использовать apimenu.ru для проверки доступных типов оплат организаций.
Чтобы получить список доступных типов оплат, необходимо сделать запрос к API iiko по адресу /api/1/payment_types. В запросе нужно указать заголовок Authorization с токеном доступа и передать идентификаторы организаций в теле запроса в формате JSON. Эти идентификаторы можно получить, используя операцию /api/1/organizations.
Для простой проверки типов оплат можно использовать инструмент apimenu.ru в разделе «организации» → оплаты
В iiko нельзя передавать дробные суммы для определенных валют. Например, если вы используете рубли, то копейки передавать не нужно. Однако, если ваша система работает с евро, то можно передавать и центы. Это связано с особенностями работы с валютами в системе.
Ошибка отрицательной цены возникает, когда в процессе обработки заказа происходит попытка установить цену товара или общую сумму заказа ниже нуля. Это связано с параметром predefinedPrice, который не может быть отрицательным. Причиной может быть неправильная настройка или ошибка в расчетах. Рекомендуется проверить все параметры заказа и убедиться, что цены установлены корректно.
При создании заказа необходимо передавать верную цену товаров без применения скидки. Скидку следует указывать в массиве discountsInfo, где discountTypeId — это ID скидки, а sum — сумма скидки, которая должна быть целым числом. Например, discountsInfo может выглядеть так: [discounts] => Array([0] => Array([discountTypeId] => '79a2fe8b-8025-4530-abcc-186ea94de847', [sum] => 150, [type] => 'RMS')). Типы скидок можно посмотреть на сайте apimenu.ru в разделе «организации» → скидки
Лояльность и iikoBiz
Вопросы по работе с iikoBiz: клиенты, телефоны, бонусы, скидки, ошибки проверки пользователей и недоступные организации в iikoBiz.
iikoBiz — это платформа, предназначенная для управления лояльностью клиентов в ресторанах и других заведениях. Она позволяет собирать и анализировать данные о клиентах, управлять их бонусами и скидками, а также проводить различные акции. Система интегрируется с iiko, что обеспечивает синхронизацию данных и упрощает процесс работы с клиентами. Рестораторы могут легко проверять информацию о клиентах и их лояльности через платформу apimenu.ru, что делает управление более эффективным.
Пользователь не найден в iikoBiz, если введенные данные, такие как номер телефона или email, не совпадают с записями в системе. Также это может происходить, если пользователь еще не зарегистрирован в iikoBiz или его учетная запись была удалена. Для проверки корректности данных можно использовать инструмент apimenu.ru, который поможет убедиться в наличии пользователя в системе. Если проблема сохраняется, рекомендуется обратиться в службу поддержки iiko для получения дополнительной информации.
Ошибка Transport_WrongCustomerNumber возникает, когда система пытается проверить существование пользователя по указанному номеру телефона. Если пользователь не найден, возвращается эта ошибка с описанием Validation_IncorrectPhone. Это может произойти, если номер телефона введен неверно или если пользователь действительно отсутствует в базе данных iikoBiz. Для проверки корректности номера телефона и существования пользователя можно использовать инструменты, такие как apimenu.ru.
Для того чтобы организация была доступна в iikoBiz, необходимо подключить её к чейну. Если вы не видите свою организацию, это может быть связано с отсутствием такого подключения. Рекомендуем обратиться в поддержку iiko для подключения iikoBiz.
Для проверки подключения iikoBiz для вашего ресторана вам необходимо зайти в настройки системы iiko и убедиться, что интеграция с iikoBiz активирована. Также вы можете использовать apimenu.ru, чтобы быстро проверить статус подключения и получить дополнительную информацию о работе с iikoBiz. Если у вас возникли трудности, обратитесь в техническую поддержку для получения помощи.
Стоп-листы и доступность
FAQ по стоп-листам и доступности блюд: временные ограничения, отсутствие товаров, проблемы синхронизации стоп-листов между организациями.
Чтобы получить стоп-листы через iiko API, необходимо отправить запрос к эндпоинту /api/1/stop_lists. В заголовке запроса укажите токен авторизации в формате 'Bearer {ваш_токен}'. В теле запроса укажите массив идентификаторов организаций, для которых требуется получить стоп-листы. Также можно указать флаг returnSize для возврата размеров блюд и список идентификаторов групп терминалов, если это необходимо. Информацию о доступных организациях и группах терминалов можно получить через запросы к /api/1/organizations и /api/1/terminal_groups соответственно. Для проверки интеграции можно использовать apimenu.ru.
Товар может быть в стоп-листе по нескольким причинам, основная из которых — его временная недоступность для продажи или отсутствие на складе. Стоп-листы устанавливаются через терминал iiko в кафе, что позволяет управлять доступностью товаров в реальном времени. Для проверки актуальности стоп-листов и доступности товаров вы можете использовать инструмент apimenu.ru, который предоставляет актуальную информацию о наличии блюд и отслеживает изменения. Это поможет вам быть в курсе текущей ситуации с товарами и принимать обоснованные решения.
У API iiko существует ограничение на количество запросов к стоп-листам. Рекомендуется проверять стоп-листы не чаще чем раз в 5 минут, чтобы избежать превышения лимитов. Если необходимо обновлять стоп-листы только при их изменении, лучше воспользоваться вебхуком на изменение стоп-листов. Этот вебхук будет срабатывать только при изменении в стоп-листе, что позволяет оптимизировать запросы. Для тестирования и отладки вебхуков можно использовать инструмент «вебхук монитор» на сайте apimenu.ru.
Иногда бывает, что на терминале блюдо стоит в стопе, но по API это блюдо не в стопе. В таком случае необходимо заново установить блюдо в стоп. Сайт apimenu.ru отображает данные в реальном времени, полученные от iiko. Если на apimenu блюдо не в стопе, а на терминале оно стоит в стопе, значит API не отдает это блюдо в стопе. Рекомендуем обратиться в техническую поддержку для решения этой проблемы, так как наш сервис показывает реальную картину передачи данных из iiko во внешние сервисы.
Вебхуки
Вопросы по обработке вебхуков iiko: события заказов, статусы, ошибки доставки данных, повторные отправки и мониторинг вебхуков.
Вебхуки iiko представляют собой способ передачи данных в реальном времени о событиях, происходящих в системе, таких как изменения статусов заказов или ошибки доставки данных. Они позволяют интеграциям автоматически реагировать на изменения, что значительно упрощает процесс обработки информации. С помощью вебхуков можно настроить мониторинг событий и повторные отправки данных в случае ошибок. Это делает взаимодействие с системой более эффективным и надежным. Для проверки работы вебхуков можно использовать раздел «вебхук монитор» на сайте apimenu.ru
iiko предоставляет несколько типов событий, которые отправляются через вебхуки. К ним относятся DeliveryOrderUpdate, который сигнализирует об изменении заказа, и DeliveryOrderError, указывающий на ошибку заказа. Также отправляется StopListUpdate для обновления стоп-листов, PersonalShift для изменения смены сотрудника и ReserveUpdate для обновления резерва стола. Эти события позволяют интеграциям оперативно реагировать на изменения в системе. Для проверки работы вебхуков вы можете использовать инструмент apimenu.ru.
Если вебхук не приходит на сервер, это может быть связано с несколькими причинами. Во-первых, проверьте правильность указанного URL для вебхука. Во-вторых, возможны проблемы с сетью, которые мешают доставке данных. Также стоит убедиться, что ваш сервер работает корректно и может обрабатывать входящие запросы. Используйте инструменты, такие как apimenu.ru, для проверки состояния вебхуков и диагностики возможных ошибок.
Чтобы настроить работу вебхуков в iiko, перейдите в настройки Cloud Api и выберите нужный апилогин. Затем откройте вкладку «подключенные точки», выберите нужную точку и нажмите на шестеренку «настройка вебхуков». В окне «Изменение веб-хуков» на вкладке «основное» укажите URL для приема вебхуков. Для тестирования вы можете использовать раздел «вебхук монитор» на сайте apimenu.ru, где при авторизации по ключу будет доступен необходимый URL. Обратите внимание, что для одного ключа можно указать только один адрес приема вебхука.
Общие вопросы
Общие вопросы по интеграции с iiko API: архитектура, best practices, типовые ошибки, рекомендации по отладке и тестированию.
Для успешного тестирования интеграции с iiko API рекомендуется использовать тестовые среды, которые позволяют имитировать запросы и получать ответы от API. Это поможет выявить возможные ошибки и проверить корректность работы интеграции. Также полезно использовать инструменты, такие как apimenu.ru, которые могут помочь в проверке и отладке интеграции. Обязательно следите за логами и ответами сервера для быстрого выявления проблем.
При интеграции с iiko API часто возникают ошибки, связанные с человеческим фактором. Например, может быть не указан нужный ID организации при отправке заказа, забыты тип доставки или тип оплаты. Также часто неверно передается мобильный телефон клиента или неправильно настраиваются модификаторы. Кроме того, нередки случаи, когда не указаны города в настройках iiko. Для проверки и отладки таких ошибок можно использовать инструмент apimenu.ru.
ApiMenu значительно облегчает взаимодействие с iiko API, предлагая готовые решения для интеграции и управления данными. Это позволяет разработчикам сосредоточиться на бизнес-логике, а не на сложностях API. Инструменты, предоставляемые ApiMenu, помогают избежать типичных ошибок и ускоряют процесс отладки и тестирования. Кроме того, на сайте apimenu.ru можно найти полезные ресурсы и примеры использования, что делает работу с iiko API более эффективной и менее затратной по времени.
Вы можете найти официальную документацию API iiko по следующему адресу: https://api-ru.iiko.services/docs. Эта документация содержит все необходимые сведения о доступных методах, параметрах и примерах использования API. Рекомендуем ознакомиться с ней для получения актуальной информации и рекомендаций по интеграции. Также вы можете использовать apimenu.ru как инструмент для проверки интеграций с iiko API.
В большинстве разделов сайта apimenu есть кнопка «лог», которая предоставляет информацию, возвращаемую API iiko по запросу. Чтобы получить лог, зайдите в нужный раздел, например, во внешнее меню, и нажмите на кнопку «лог». Вы сможете скопировать ответы iiko и отправить их в техническую поддержку для анализа. Это поможет выявить причины, если, например, не отработали стоп-листы. Техническая поддержка изучит ответ iiko и поможет решить возникшую проблему.
