Рабочие места
Рабочее место — это устройство с приложением 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— расширения, подключённые на рабочем месте. Подробнее о расширениях
Активировать рабочее место
Чтобы использовать все возможности рабочего места, его надо активировать. Для этого сотрудник, начинающий работу, должен ввести код активации. Код активации вводится один раз и действует, пока вы не деактивируете рабочее место или не очистите данные приложения.
Код активации генерируется 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
Вот и всё, что касается рабочих мест. В следующей статье разберём работу с терминалами.