Организация
Организация в системе LIFE POS — это ваш бизнес. В организации может быть несколько юридических лиц, как и несколько магазинов. Их объединяет то, что они работают на вас. Рассказываем, что можно сделать с организацией через API LIFE POS.
Проверить псевдоним
У каждой организации в системе LIFE POS есть псевдоним — значение поля alias. Этот псевдоним должен быть уникальным. Чтобы проверить доступность придуманного псевдонима, отправьте POST-запрос по адресу:
{base_url}/orgs:check-alias-availability
base_url — адрес сервиса. Возможные значения:
https://api-dev.life-pos.ru— тестовый API,https://api.life-pos.ru— рабочий API.
Добавить организацию
Чтобы добавить организацию, отправьте POST-запрос по адресу:
{base_url}/orgs
Метод отправит вам смс с логином и пин-кодом для входа в приложение LIFE POS.
Кроме организации, метод создаст:
- Роли пользователей по умолчанию.
- Страницу с контактами техподдержки, если вы заполнили поле support.
- Сотрудника организации с ролью Владелец. Сотрудник привязывается к аккаунту, от которого поступил запрос на создание организации.
- Сущность Системная валюта (
OrganizationOption: SYSTEM_CURRENCY) со значениемRUB. - Единицы измерения:
Не задана,Килограмм,Штука,Литр. - Расширения, данные которых вы указали в объекте
extensions.
В тело запроса входит объект support — контакты поддержки, которые будут выводиться в приложении для курьера. Если их не передать, в приложении будут контакты поддержки LIFE POS. Вот что можно настроить в объекте support:
line— название компании для заголовка: Контакты техподдержки%line%. Например:Контакты техподдержки LIFE POS.responsibility— краткое описание вопросов, по которым помогает поддержка. Например:Обращайся сюда, если есть вопросы по заказам;phone— телефон,email— электронная почта,opening_hours— часы работы,whatsapp,viber,telegram.
Получить данные организации
Чтобы получить список организаций, отправьте GET-запрос по адресу:
{base_url}/orgs
Данные выводятся постранично, по 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}
Изменить данные организации
Менять данные организации нужно, например, если вы начали работать с новым расширением. Можно задать настройки расширений один раз на уровне организации, и их унаследуют все элементы, входящие в организацию: торговые точки, сотрудники, рабочие места и т. д.
Подробнее про расширения
У каждого объекта в 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 от ЦКТ |
Чтобы скорректировать данные, отправьте PATCH-запрос по адресу:
{base_url}/orgs/{org_guid}
В теле запроса передайте изменения.
Удалить и восстановить данные организации
Полностью удалить данные организации нельзя, но их можно отправить в архив. Данные исчезнут из интерфейса, но сохранятся на сервере LIFE POS. Чтобы заархивировать данные, отправьте DELETE-запрос по адресу:
{base_url}/orgs/{org_guid}
Чтобы восстановить данные из архива, отправьте POST-запрос по адресу:
{base_url}/orgs/{org_guid}:unarchive
Вот и всё, что касается настроек организации. В следующей статье поговорим об импорте каталога товаров.