API требуется для подключения сторонних сайтов или мобильных приложений.

По API можно: 

  • Получить меню с учетом стоп-листа
  • Создать заказ
  • Изменить заказ
  • Отменить заказ
  • Найти заказы
  • Получить справочную информацию

Через API можно работать только с заказами, которые созданы через это подключение.

Создание нового подключения

Чтобы создать новый источник заказа, пользователю системы доставки необходимо зарегистрировать его в разделе Интеграции/Подключение по API > Подключение по API в административной панели.

  1. Нажмите на кнопку Добавить подключение по API.

    Откроется окно нового подключения по API.
  2. Укажите обязательные параметры:
    • Название подключения — нажмите на галочку для сохранения названия
    • Email контактного лица
    • Доступные заведения
  3. В блоке Меню можно выбрать представление меню, по которому будет работать сайт или приложение.
  4. Нажмите на кнопку Сохранить.
  5. Войдите в карточку созданного подключения.
    Теперь ему присвоены:
    • Client ID (16 символов)
    • Client Secret (публичный ключ - 128 символов)

      При необходимости можно обновить публичный ключ по кнопке Сгенерировать.
      По этому ключу сервис выполняет запросы по методам API к системе r_keeper Delivery для получения данных. Например: для загрузки меню или поиска заказа.
  6. Данные о подключениях можно изменять.
    Чтобы выключить подключение, нажмите на кнопку Выключить в режиме редактирования.