Skip to content

Latest commit

 

History

History
76 lines (69 loc) · 6.19 KB

readme.md

File metadata and controls

76 lines (69 loc) · 6.19 KB

Реализованные методы iiko Card API

  • Аутентификация и авторизация
    • Получить маркер доступа апи логина
    • Проверка маркера доступа апи логина
    • Получить маркер доступа пользователя biz
    • Получить информацию о заданном пользователе biz, доступную для заданного апи логина
    • Типичная схема взаимодействия с внешними приложениями
  • Организации
    • Получение списка организаций
    • Получение информации о заданной организации
    • Получить списки организаций, доступных пользователям приложения
  • Методы iikoCard5
    • Получить список активных программ корпоративного питания для организации
    • Рассчитать программу лояльности для заказа
    • Получить описание всех комбо и категорий комбо для организации
    • Получить ручные условия
    • Проверить комбо-блюдо и рассчитать его стоимость
    • Получить данные гостя по его номеру телефона
    • Получить данные гостя по его идентификатору
    • Получить данные гостя организации по его номеру карты
    • Создать гостя или обновить информацию о госте
    • Добавить категорию гостю
    • Удалить категорию у гостя
    • Создать новую карту гостю
    • Удалить карту у гостя
    • Пополнить кошелек пользователя
    • Списать сумму со счета пользователя
    • Включить гостя в программу корпоративного питания
    • Исключить гостя из программы корпоративного питания
    • Отправить sms-сообщение от имени ресторана
    • Отправить email
    • Получить отчет по заказам программы корпоративного питания за период
    • Получает отчет по заказам гостей указанной программы корпоративного питания за указанный период.
    • Получить краткую информацию по гостям за период
    • Получить категории гостей
    • Получить метрики гостей (кол-во, сумму заказов)
    • Получить балансы гостей
    • Получить отчет по транзакциям гостей организации за период
    • Получает отчет по транзакциям гостей организации за указанный период.
    • Получить категории гостей по организации
    • Подписаться на уведомления об изменении балансов пользователей
    • Подписаться на уведомления/изменить настройки подписки об изменении балансов/категорий пользователей/карт/участие в программе
    • Удалить подписку на уведомления об изменении балансов пользователей
    • Удалить подписку на уведомления об изменении балансов/категорий пользователей/карт/участие в программе
    • Получить все подписки об изменении баланса, созданные api-пользователем
    • Получить все подписки, созданные api-пользователем
    • Создать категорию гостей или обновить существующую
    • Получить программы по организации/сети
    • Создать маркетинговую акцию
    • Обновить маркетинговую акцию
    • Создать программу
    • Обновить программу
  • Мобильное приложение iikoCard5
    • Аутентификация номера телефона гостя
    • Чек-ин в заказ
    • Обновить заказ
    • Получить состав заказа
    • Получить настройки мобильного приложения

Инфо

Все названия методов соответствуют названию в ссылке (смотрите документацию iiko biz api)

Пример названия метода получения маркера доступа: /api/0/auth/access_token?user_id={user_id}&user_secret={user_secret}

Example

from pyiikoapi import CardService or from pyiikoapi.card import CardService

# инициализация класса 
api = CardService(login,password,organizationId)
# получаю список организаций, определяю request_timeout = 2 минутам
organization_info = api.list(params={"request_timeout": "00%3A02%3A00"})

Каждый метод проверяет время жизни маркера доступа, если время жизни маркера прошло то будет автоматически запрошен заново.

Время жизни маркера доступа равно 15 минутам.