Подсистема обмен УНПФ: различия между версиями
Нет описания правки |
Нет описания правки |
||
| Строка 40: | Строка 40: | ||
*[[#6.3.1 Описание параметров, которые подлежат регистрации по ФЛ/ЮЛ и используются при обмене данными|<span style="color:#000000"><small>6.3.1 Описание параметров, которые подлежат регистрации по ФЛ/ЮЛ и используются при обмене данными</small></span>]] | *[[#6.3.1 Описание параметров, которые подлежат регистрации по ФЛ/ЮЛ и используются при обмене данными|<span style="color:#000000"><small>6.3.1 Описание параметров, которые подлежат регистрации по ФЛ/ЮЛ и используются при обмене данными</small></span>]] | ||
*[[#6.3.2 Описание Запроса и ответа на Обмен изменениями по Клиентам|<span style="color:#000000"><small>6.3.2 Описание Запроса и ответа на Обмен изменениями по Клиентам</small></span>]] | *[[#6.3.2 Описание Запроса и ответа на Обмен изменениями по Клиентам|<span style="color:#000000"><small>6.3.2 Описание Запроса и ответа на Обмен изменениями по Клиентам</small></span>]] | ||
*[[#6.4 Сервисы по НПО. (NPO_PSChg_Request) Обмен изменениями по ПС и ПД (НПО)|<span style="color:#000000"><small>6.4 Сервисы по НПО. (NPO_PSChg_Request) Обмен изменениями по ПС и ПД (НПО)</small></span>]] | |||
</div> | </div> | ||
|style="vertical-align:top;| | |style="vertical-align:top;| | ||
| Строка 1315: | Строка 1316: | ||
Структура объекта «buildings» | Структура объекта «buildings» | ||
: {|class="wikitable" | |||
! style="background:#EAECF0"| '''Элемент''' | |||
! style="background:#EAECF0"| '''Описание''' | |||
! style="background:#EAECF0"| '''Тип данных''' | |||
|- | |||
|type | |||
|Тип здания (строение, корпус….) | |||
|Строка | |||
|- | |||
|number | |||
|Номер здания | |||
|Строка | |||
|} | |||
Структура объекта «apartments» | |||
: {|class="wikitable" | |||
! style="background:#EAECF0"| '''Элемент''' | |||
! style="background:#EAECF0"| '''Описание''' | |||
! style="background:#EAECF0"| '''Тип данных''' | |||
|- | |||
|type | |||
|Тип помещения (квартира….) | |||
|Строка | |||
|- | |||
|number | |||
|Номер помещения | |||
|Строка | |||
|} | |||
Структура объекта «statements» | |||
: {|class="wikitable" | |||
! style="background:#EAECF0"| '''Элемент''' | |||
! style="background:#EAECF0"| '''Описание''' | |||
! style="background:#EAECF0"| '''Тип данных''' | |||
|- | |||
|OPS | |||
|Наличие договора/счета ОПС | |||
|Boolean | |||
|- | |||
|NPO | |||
|Наличие договора/счета НПО | |||
|Boolean | |||
|- | |||
|PDS | |||
|Наличие договора/счета ПДС | |||
|Boolean | |||
|} | |||
<h2>'''6.4 Сервисы по НПО. (NPO_PSChg_Request) Обмен изменениями по ПС и ПД (НПО)'''</h2> | |||
[[Категория:УНПФ| ]] | [[Категория:УНПФ| ]] | ||
Версия от 13:06, 22 июля 2025
| |||
|
| ||
|
Версия документа
1 Назначение модуляМодуль предназначен для предоставления необходимой информации для внешних систем (Например: СРМ, ЛК и т.п.) из подсистемы пенсионного учета УНПФ8 по НПО,ПДС и ОПС. Модуль работе в виде http-сервиса. Формат сообщений = json. Модуль доступен после покупки и активации соответствующей лицензии на сервере СЛК. Наименование модуля в УНПФ8 и в СЛК = «Обмен УНПФ». 2 ЦелиСервиса реализован в 1С (конфигурация УНПФ8) для предоставления данных внешним системам. На стороне 1С ведется регистрация изменений данных по клиентам (ФЛ) и данных по пенсионным счетам и договорам, а также операций (документов) с ними связанных Для каждой внешний системы в 1С создается «узел обмена», в рамках которого производится учет регистрация изменений и обмен данными. Обмен данными производится в виде «сообщений», в рамках которых регистрируется успешная или неуспешная передача данных. Предусмотрены отдельные сервисы для получения полных данных выборочно по конкретным клиентам вне рамок подсистемы регистрации изменений. Настройка реализована для вида учета по НПО, ПДС и ОПС. В рамках сервиса предусмотрена только предоставление данных по запросу. Загрузка информации в 1С (УНПФ8) не предусмотрена, т.е. загрузка новых договоров, участников и т.п. в рамках данного сервиса не предусмотрена. 3 Принятые сокращения и общие параметры
4 Настройка сервиса обмена 1С: УНПФДля предоставления данных внешним системам необходимо осуществить настройку сервисов обмена на форме «Настройки сервиса обмена УНПФ», которая доступна в разделе «Общие настройки УНПФ»/«Сервис доступа к данным УНПФ8» Данная настройка выполняется индивидуально для каждой внешней системы. Настройка доступна только пользователю с полными правами. Параметр «Пользователь» определяет от имени какого пользователя будет производится подключение к 1с со стороны внешней системы. Такой пользователь и его пароль задается администратором системы 1с. У пользователя должны быть доступна роль «Доступ к сервису УНПФ». Параметр «Организация» - используется для отбора данных, которые передаются через сервис. Параметр «Имя модуля» - если не задан, то используется модуль поставщика с предопределенным именем «уп_ИнтеграцияСВнешнимиСистемами». Либо указывается имя общего модуля, который настроен под требования организации. В модуле прописывается порядок сбора информации и формирование ответа json. Установка флага «Действует» предоставляет внешнему пользователю возможность получать данные из системы УНПФ. При подключении внешнего пользователя производится сверка есть ли для него данная настройка обмена и действует ли она. В рамках группы сервисов по регистрации изменений проверяется включена ли регистрация таких изменений (задан ли узел обмена и включен ли флаг «регистрировать изменения»). Если регистрация изменений не включена или не настроена, то будет ответ с кодом ошибки и с описанием ошибки (404,"Не указан в настройках источник данных"). Значение «Макс количество идентификаторов…» для GET-запросов по умолчанию равно 40, для POST-запросов 100 000. На закладке «Планы обмена» настраиваются узлы обмена для каждого пользователя (внешняя система). В узлах обмена производится регистрация и накопление изменений с момента последнего успешного обмена. Рекомендуется имя для узлов задавать по следующей маске: «Имя внеш. системы (пользователь)»-«Вид регистрируемых данных». Предусмотрены следующие виды регистрируемых данных (изменений): Контрагенты, ПС НПО, ПС ПДС, Договоры ОПС, Резервы НПО, Резервы ПДС, Резервы ОПС. Флаг «Регистрировать изменений» - если флаг установлен, то производится регистрация изменений в заданном узле обмена. Флаг устанавливается/снимается по кнопке «Вкл»/ «Откл». Параметр «№ Сообщения» - последний номер сообщения, который был передан в результате обмена. 5 Виды сервисов1. В рамках проекта предусматривается разработка две группы сервисов для вида учета НПО/ПДС/ОПС:
Предусмотрена возможность получения полного списка клиентов. 2. Аутентификация сервисов в базе данных 1С производится: по логину и паролю 1С. 3. Каждому узлу обмена (внешнему клиенту) присваивается идентификатор (по умолчанию планируется использовать логин и пароль). При обмене данный параметр является обязательным. 4. В имени каждой функции сервиса и у каждого плана обмена 1с8 устанавливается префикс, который характеризуем систему обмена в рамках вида учета NPO(НПО), OPS(ОПС), PDS(ПДС). 5.1 Описание группы сервисов, в рамках которых ведется учет регистрации изменения передаваемых данных по НПО/ПДС/ОПСИмена сервисов в документе содержат в имени дефис, для удобства визуального восприятия. По мере завершения работы над документом дефис будет замен на символ подчёркивания. Все сообщения обмена через это набор сервисов производится в разрезе номеров сообщений в рамках каждого узла обмена (клиент). По результатам успешного обмена узел обмена обязан передать сообщение об успешном прохождении обмена по номеру сообщения (квитирование). Данный учет необходим для реализации учета какой набор изменённых данных требуется передать узлу обмена с момента последнего обмена. И как следствие регистрация учета изменений ведется в рамках каждого узла отдельно (что позволит реализовать независимый учета обмена измененными данными между разными системами. Например, таким как ЛК и Синтакси). Предусмотрены следующий набор сервисов (структура обмена будет описана в подразделах): 1. Общие сервисы (без привязки к НПО/ОПС/ПДС) 1.1. («StatusExchange») Информирование об успешном прохождении сообщений
1.2. («ClientsChg_Request») Обмен изменениями по Клиентам:
2. Сервисы по НПО: 2.1. («NPO_PSChg_Request») Обмен изменениями по ПС и ПД (НПО)
2.2. («NPO_OperationsChg_Request») Обмен изменениями по движениям (выписка по ПС) (НПО) -в рамках движений денежных средств по ПС:
3. Сервисы по ПДС: 3.1. («PDS_PSChg_Request») Обмен изменениями по ПС и ПД (ПДС)
3.2. («PDS_OperationsChg_Request») Обмен изменениями по движениям (выписка по ПС) (ПДС) -в рамках движений денежных средств по ПС:
4. Сервисы по ОПС: 4.1. («OPS_PSChg_Request») Обмен изменениями по Договорам (ОПС)
4.2. («OPS_OperationsChg_Request») Обмен изменениями по движениям (выписка по Договору) (ОПС) -в рамках движений денежных средств по Договору:
5.2 Описание группы сервисов, в рамках которых не ведется учет регистрации изменения передаваемых данныхВ рамках данной группы сервисов не предусмотрен контроль подтверждения успешного прохождения сообщений. Вызывать сервис можно через как через GET, так и через POST. При вызове через POST в тело запроса передается JSON с массивом UID клиентов или счетов (в зависимости от сервиса). Пример структуры JSON: { " uids": [ "7a2e005a-8efd-11e3-be8c-74d02bc3313d", "87e21ffa-cb82-11e3-be9d-74d02bc3313d", "87e21fff-cb82-11e3-be9d-74d02bc3313d" ] } Обращаем внимание, что через GET запрос используется параметр uid, а POST запросе используется параметр uids. 1. Общие сервисы (без привязки к НПО/ПДС): 1.1. (Функция «ClientsID_Request») Список идентификаторов клиентов:
1.2. (Функция «ClientsInfo_Request») Получение информации по клиентам:
2. Сервисы по НПО: 2.1. (Функция «NPO_PS_Request») Получить данные по ПС клиентов НПО:
2.2. (Функция «NPO_Operations_Request») Получить полную выписку по счетам НПО:
3. Сервисы по ПДС: 3.1. (Функция «PDS_PS_Request») Получить данные по ПС клиентов ПДС:
3.2. (Функция «PDS_Operations_Request») Получить полную выписку по счетам ПДС:
4. Сервисы по ОПС: 4.1. (Функция «OPS_PS_Request») Получить данные по Договорам клиентов ОПС:
4.2. (Функция «OPS_Operations_Request») Получить полную выписку по Договорам ОПС:
6 Описание сервисов НПО/ПДС/ОПСИмена сервисов в документе содержат в имени дефис, для удобства визуального восприятия. По мере завершения работы над документом дефис будет замен на символ подчёркивания. 6.1 АвторизацияМеханизм авторизации в БД реализован посредством проверки логина и пароля 1С. Возможно, потребуется реализация отдельных прав для такого пользователя. http://[host]/hs/unpfAPI/v1/test - тест доступности сервиса 6.2 Общие сервисы. (StatusExchange) Подтверждение успешного обмена (НПО/ПДС/ОПС)Номера сообщений используются в механизмах обмена данными для контроля доставки переданной информации. Т.к. история изменений будет передаваться с момента последнего успешного номера сообщения в рамках конкретного узла обмена. Параметры этого обмена будут скорректированы по мере необходимости или по мере реализации. 6.2.1 Описание параметров, которые следует учесть в сообщении при обменеДля подтверждения успешного прохождения обмена требуется передать информацию:
Входящие параметры: 1. ГУИД узла обмена в 1с для данной внешней системы 2. Номер сообщения (в рамках сервиса обмена) Путь к сервису: [host]/hs/unpfAPI/v1/StatusExchange/ Описание JSON запрос:
Описание HTTP ответа: Cтрока ответа HTTP, содержит следующую информацию:
6.3 Общие сервисы. (ClientsChg_Request) Обмен изменениями по КлиентамУчет регистрации изменений ведется во всем контрагентам ФЛ с флагом «хранить данные перс. учета» и по всем ЮЛ. В рамках данного сервиса передаются персональные данные по ЮЛ/ФЛ без отбора по НПО/ПДС/ОПС и т.п. Наличие ПС по НПО/ПДС/ОПС проверяется по Справочнику уп_ПенсионныеСчета, пдс_ПенсионныеСчета, уп_ДоговорыОПС соответственно. 6.3.1 Описание параметров, которые подлежат регистрации по ФЛ/ЮЛ и используются при обмене даннымиОбъекты для учета регистрации изменений и последующей передаче через сервис Регистрация ФЛ проводится только тех, у кого стоит флаг «Хранить данные перс.учета» 1. Объекты контроля для регистрации изменений: 1.1. Справочник. Контрагенты 1.2. Справочник.ФизЛица 1.3. РС. ФИОФизическихЛиц 1.4. РС. ФизическиеЛицаДокументов 2. Извлекаемые данные из объектов контроля для передачи через сервис: 2.1. ФЛ: 2.1.1. ТипКонтрагента (1-ФЛ, 2-ЮЛ, 0 — это ошибка в базе) 2.1.2. ГУИД контрагента /guidClient 2.1.3. Дата последнего изменения персональных данных клиента, в Формате ДатаВремя 2.1.4. КодКонтрагента / npoCode / 2.1.5. Контрагент-ПометкаНаУдаление 2.1.6. СНИЛС/ snils 2.1.7. ИНН/ inn 2.1.8. ФИО: 2.1.8.1. Фамилия/ surname 2.1.8.2. Имя/ name 2.1.8.3. Отчество/ patronymic 2.1.9. ФИО при рождении / birthPersonal 2.1.9.1. Фамилия/ surname 2.1.9.2. Имя/ name 2.1.9.3. Отчество/ patronymic 2.1.10. Пол/ sex 2.1.11. ДатаРождения/ birthDate 2.1.12. МестоРождения/ birthPlace 2.1.13. ДатаСмерти/ deathDate 2.2. Сведения о наличии правопреемников: 2.2.1. Есть назначенные ПП в НПО (Проверка через заявления ЗаявлениеОНаличииПравопреемниковНПО) – Тип Булево 2.2.2. Есть назначенные ПП в ПДС(Проверка через заявления ЗаявлениеОНаличииПравопреемниковПДС) – Тип Булево 2.2.3. Есть назначенные ПП в ОПС(Проверка через заявления ЗаявлениеОНаличииПравопреемниковОПС) – Тип Булево 2.3. Контактная информация (коллекция телефонов, адресов, email): 2.3.1. Номер по порядку 2.3.2. ТипКонтактнойИнформации – см. Табл.1 «Типы и виды контактной информации ФЛ» 2.3.3. ВидКонтактнойИнформации - – см. Табл.1 «Типы и виды контактной информации ФЛ» 2.3.4. Значение (Представление)/ singleString 2.3.4.1. Структура Адреса: (заполняется только, если ТипКонтактнойИнформации= Адрес). Поля структуры адреса могут быть скорректированы. 2.3.4.2. Адрес в формате JSON. 2.3.4.3. Страна/country 2.3.4.4. Регион представление/ regionName 2.3.4.5. Город/ town 2.4. Документ, удостоверяющий личность (паспорт) – коллекция документов: 2.4.1. Код (код документа)/ code – виды кодов представлены в табл.2 «Коды документов» 2.4.2. Серия/ seria 2.4.3. Номер/ number 2.4.4. Дата (дата выдачи)/ date 2.4.5. Кем выдан/ org 2.4.6. Код кем выдан/ orgCode – только для паспорта РФ 2.5. ЮЛ: 2.5.1. ТипКонтрагента=Булево (1-ФЛ, 2-ЮЛ, 0 — это косяк в базе) 2.5.2. ГУИД контрагента / guidClient 2.5.3. Дата последнего изменения персональных данных клиента, в Формате ДатаВремя 2.5.4. КодКонтрагента /npoCode/ 2.5.5. ИНН/ inn 2.5.6. КПП 2.5.7. Наименование 2.5.8. Полное наименование 2.5.9. Контрагент-ПометкаНаУдаление 2.6. Сведения о наличии ПС: 2.6.1. Есть НПО- Истина, если является участником/вкладчиком НПО, иначе Ложь 2.6.2. Есть ПДС- Истина, если является участником/вкладчиком ПДС, иначе Ложь 2.6.3. Есть ОПС - Истина, если является участником ОПС, иначе Ложь Табл.1 «Типы и виды контактной информации ФЛ»
Указаны предопределенные типы и виды контактной информации, но они могут быть расширены в рамках пользовательских настроек системы. Табл.2 «Коды документов»
6.3.2 Описание Запроса и ответа на Обмен изменениями по КлиентамПараметры: ID узла обмена / ключ Путь к сервису: [host]/…/ClientsChg_Request Описание JSON запрос:
Описание JSON ответа: Структура объекта «package» - содержит GUID узла, зарегистрировавшего изменения и номер пакета сообщения
Структура массива объектов «clients» - информация о контрагентах
Структура объекта «client» для Юридических лиц
Структура объекта «client» для Физических лиц
Таблица. Значения статусов контрагента по пенсионным счетам НПО
Структура объекта «Personal»
Структура объекта «Documents» - документы, удостоверяющие личность (ДУЛ) последние на дату (возможны разные виды документов, действующих на дату выгрузки)
Структура объекта «Phones» - телефоны контрагента
Структура объекта «Emails» - электронные адреса контрагента
Структура объекта «Addresses» - адреса контрагента
Таблица. Значения Кодов типов адреса
Структура объекта «AddressJSON» - элементы адреса контрагента
Структура объекта «buildings»
Структура объекта «apartments»
Структура объекта «statements»
6.4 Сервисы по НПО. (NPO_PSChg_Request) Обмен изменениями по ПС и ПД (НПО) |


