Сотрудники
У каждого сотрудника, работающего с LIFE POS, должна быть учётная запись в системе. Вы можете работать с учётными записями сотрудников в личном кабинете (ЛК) или по API. Рассказываем, какие данные сотрудников хранит система и как работать с ними по API.
Добавить учётную запись
Чтобы добавить сотрудника, отправьте POST-запрос по адресу:
{base_url}/v5/orgs/{org_guid}/employees
base_url — адрес сервиса. Возможные значения:
https://api-dev.life-pos.ru— тестовый API,https://api.life-pos.ru— рабочий API.
Авторизовать сотрудника
Для доступа к сервисам LIFE POS сотруднику нужны пин-код или пароль. Чтобы сгенерировать их вместе, отправьте POST-запрос по адресу:
{base_url}/v5/orgs/{org_guid}/employees/{employee_guid}:reset-credentials
Если сотрудник входит на рабочее место впервые, рабочее место потребуется активировать. Как активировать рабочее место
Если сотрудник забыл свои учётные данные, пин-код и пароль можно сгенерировать по отдельности.
Чтобы сгенерировать пин-код, отправьте POST-запрос по адресу:
{base_url}/v5/orgs/{org_guid}/employees/{employee_guid}:reset-pincode
Описание запроса Чтобы сгенерировать пароль, отправьте POST-запрос по адресу:
{base_url}/v5/orgs/{org_guid}/employees/{employee_guid}:reset-password
По API можно менять учётные данные всех пользователей, кроме Владельца бизнеса. Роли пользователей
Получить данные учётной записи
Чтобы получить список сотрудников, отправьте GET-запрос по адресу:
{base_url}/v5/orgs/{org_guid}/employees
Данные выводятся постранично, по 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}/v5/orgs/{org_guid}/employees/{employee_guid}
Изменить данные учётной записи
Если у сотрудника изменился номер телефона, адрес электронной почты или фамилия, отразите изменения в системе. Чтобы изменить данные сотрудника, отправьте PATCH-запрос по адресу:
{base_url}/v5/orgs/{org_guid}/employees/{employee_guid}
В теле запроса передайте изменения.
Удалить или восстановить учётную запись
Полностью удалить данные сотрудника нельзя, но их можно отправить в архив. Они исчезнут из рабочих интерфейсов, но сохранятся на сервере LIFE POS. При необходимости их можно восстановить.
Чтобы заархивировать учётную запись, отправьте DEL-запрос по адресу:
{base_url}/v5/orgs/{org_guid}/employees/{employee_guid}
Чтобы восстановить учётную запись, отправьте POST-запрос по адресу:
{base_url}/v5/orgs/{org_guid}/employees/{employee_guid}:unarchive
Вот и всё, что нужно, чтобы работать с учётными записями сотрудников. В следующей статье обсудим рабочие места.