API
Раздел Настройка техники → API содержит токен облака, описание публичных методов, примеры запросов и файл OpenAPI (JSON) для разработчика интеграции.
Подключить внешнюю систему
- Откройте раздел и скопируйте Ваш API токен.
- Скачайте OpenAPI (JSON) и передайте спецификацию разработчику интеграции.
- Используйте базовый адрес, показанный в консоли, и префикс своего облака.
| Параметр запроса | Назначение |
|---|---|
| cloudPrefix * | Префикс облака в query-параметре каждого метода. |
| Authorization * | Заголовок Bearer ВАШ_ТОКЕН. |
| Content-Type * для POST с JSON | Значение application/json. |
Токен действует для всех заведений этого облака. Храните его в настройках серверной части своей интеграции. Обновить токен сразу отключает старый для новых запросов: после обновления замените его во всех использующих системах.
Каталоги и онлайн-заказы
Публичные методы позволяют получать заведения, залы и столы, синхронизировать техкарты и модификаторы и создавать онлайн-заказ. Справочник столов не показывает их текущую занятость или открытые чеки.
Для каталогов используется манифест со списком идентификаторов и хешами. Интеграция запрашивает новые и изменённые записи пакетами и удаляет локальные записи, которых больше нет в полном манифесте. Точные ограничения, поля и примеры находятся в этом же разделе консоли и в OpenAPI.
Создание онлайн-заказа — действие с рабочими данными. Перед отправкой проверьте заведение, товары, цены, модификаторы и данные гостя. Для повторной попытки одного и того же заказа используйте предусмотренный спецификацией ключ идемпотентности, чтобы не создавать дубликаты.
Для получения уведомлений об изменениях отдельно настройте вебхуки. API-токен, пароль кассового терминала, API-ключ киоска и ключ интеграции 1С — разные реквизиты.