Рабочие места

Рабочее место — это устройство с приложением LIFE POS — смартфон или онлайн-касса. За одним рабочим местом могут работать разные сотрудники. Без рабочего места работать не выйдет, так что за каждым новым кассиром или курьером нужно закрепить хотя бы одно. Объясняем, как управлять рабочими местами через API LIFE POS.

Добавить рабочее место

Чтобы добавить рабочее место, отправьте POST-запрос по адресу:

{base_url}/orgs/{org_guid}/workplaces

base_url — адрес сервиса. Возможные значения:

• https://api-dev.life-pos.ru — тестовый API,
• https://api.life-pos.ru — рабочий API.

Параметры тела запроса (знаком * отмечены обязательные):

• workplace_type * — тип рабочего места. Параметр определяет принцип заполнения адреса места расчётов в чеке. Возможные значения:
  • Unknown;
  • Mobile — касса для развозной торговли. Место расчётов определяется в момент печати чека;
  • Stationary — стационарная касса. Место расчётов задаётся при регистрации и не меняется;
  • Automat — касса, которая может работать и как мобильная, и как стационарная.
• extensions — расширения, подключённые на рабочем месте.

Подробное описание запроса

Подробнее про расширения

У каждого объекта в LIFE POS есть базовый набор полей. Их достаточно для простых операций, таких как продажа товара по безналичному расчёту или возврат денежных средств. Чтобы сделать более сложную логику, понадобятся дополнительные параметры или даже объекты.

К любому объекту в LIFE POS можно добавить дополнительные поля. Для этого используются расширения (extensions). Набор дополнительных полей у каждого расширения отличается. Вы можете выбрать подходящее и использовать только нужные параметры.

Например, рассмотрим объект «Торговая точка». Его основные параметры без расширений: название, адрес, юридический статус и название компании. С помощью расширения payment_methods можно добавить параметр «Доступные методы оплаты». Это позволит указывать какие способы оплаты доступны на каждой торговой точке. Например, таким способом можно запретить курьерам принимать наличные.

Расширения позволяют использовать для интеграции только нужные поля. Таким образом, для каждой интеграции формируется уникальный набор расширений.

В текущей версии LIFE POS невозможно создавать пользовательские расширения и работать с ними. В интеграции можно использовать только готовые расширения от LIFE PAY. Они доступны всем пользователям с платной подпиской по тарифу «Бизнес». Такая подписка даёт доступ к работе с API сервера LIFE POS и ко всем расширениям. Подробное описание всех тарифов см. на нашем сайте.

Имя	Описание
payment_methods	Доступные методы оплаты
discounts	Скидка на позицию и на чек. Как работать со скидками
retail_app	Доступные операции на точке, со сделкой или с позициями. Как управлять доступными операциями
lifepay_auth	Быстрая аутентификация в LIFE PAY
lifepay_cloud_fiscalization	Облачная фискализация для торговой точки
lifepay_quick_payments	Платежи через СБП на торговой точке
notification_service	Сервис webhook-уведомлений
external_discount_calculator	Внешний калькулятор скидок и подарков
nadex_soft_pos	SoftPOS от Nadex
ckt_soft_pos	SoftPOS от ЦКТ

Активировать рабочее место

Чтобы использовать все возможности рабочего места, его надо активировать. Для этого сотрудник, начинающий работу, должен ввести код активации. Код активации вводится один раз и действует, пока вы не деактивируете рабочее место или не очистите данные приложения.

Код активации генерируется POST-запросом по адресу:

{base_url}/v6/orgs/{org_guid}/workplaces/{workplace_guid}:generate-activation-code

Адреса сервиса

Описание запроса

Код активации можно отправить в смс сотруднику. Для этого передайте параметр send_sms=true. В описании сотрудника должен быть указан его номер телефона.

Сотрудники

Теперь код активации нужно передать в API. Для этого отправьте POST-запрос по адресу:

{base_url}/v6/auth/activate-workplace

В параметре activation_code передайте код активации, полученный ранее. В ответ вы получите параметр token, который можно использовать для авторизации на рабочем месте.

Описание запроса

Кроме кода активации сотруднику нужно ввести пин-код или пароль. Их можно настроить в данных сотрудника. Там же есть запрос на отправку данных для входа в смс.

Как настроить пин-код и пароль

Пример процесса активации вы уже видели в статье «Быстрый старт». Там вы активировали бесплатное рабочее место.

Получить данные о рабочем месте

Вы можете получить полный список рабочих мест, закреплённых за вашей организацией. Для этого отправьте GET-запрос по адресу:

{base_url}/orgs/{org_guid}/workplaces

Адреса сервиса

Описание запроса

Данные выводятся постранично, по 20 записей на страницу. Если нужно получить данные второй страницы, возьмите из ответа значение параметра next_page_token и отправьте новый запрос, передав это значение в параметре page_token. Продолжайте до тех пор, пока параметр next_page_token не придёт пустым.

Например, вы запросили данные о сотрудниках и получили такой ответ:

“next_page_token”: “OdDEFa2CzpYdp1CmlO9s9mjBn4NkUZB3CXKOtNfQWM0”,
“page_number”: 1,
“pages_total”: 2,
“items_per_page”: 20,
“items_total”: 27,

В ответе представлены только записи 1–20. Чтобы посмотреть записи с 21 по 27, отправьте новый GET-запрос, указав page_token=“OdDEFa2CzpYdp1CmlO9s9mjBn4NkUZB3CXKOtNfQWM0”.

Важно

В запросе есть необязательный параметр selection. Это фильтр рабочих мест по их статусу. Если параметр не передан, по умолчанию используется значение alive_only, то есть в ответе придут только данные рабочих мест, не перенесённых в архив. Чтобы посмотреть весь список рабочих мест или только архивные данные, укажите значение all или archived_only соответственно.

Чтобы получить данные о конкретном рабочем месте, отправьте GET-запрос по другому адресу:

{base_url}/orgs/{org_guid}/workplaces/{workplace_guid}

Описание запроса

Изменить данные рабочего места

Иногда нужно изменить данные рабочего места — например, если вы хотите предоставить доступ к новому расширению. Для этого отправьте PATCH-запрос по адресу:

{base_url}/orgs/{org_guid}/workplaces/{workplace_guid}

Адреса сервиса

Описание запроса

В теле запроса передайте изменения.

Удалить и восстановить рабочее место

Рабочее место нельзя удалить навсегда, но можно перенести в архив. Оно исчезнет из интерфейсов, но сохранится на сервере LIFE POS. Чтобы заархивировать рабочее место, отправьте DEL-запрос по адресу:

{base_url}/orgs/{org_guid}/workplaces/{workplace_guid}

Адреса сервиса

Описание запроса

Чтобы восстановить рабочее место, отправьте POST-запрос по адресу:

{base_url}/orgs/{org_guid}/workplaces/{workplace_guid}:unarchive

Описание запроса

Деактивировать рабочее место

Чтобы деактивировать рабочее место, отправьте POST-запрос по адресу:

{base_url}/orgs/{org_guid}/workplaces/{workplace_guid}:deactivate

Адреса сервиса

Описание запроса

Вот и всё, что касается рабочих мест. В следующей статье разберём работу с терминалами.