Взаимодействие с Платформой цифрового взаимодействия ГосQR
| Атрибут | Значение |
|---|---|
| Название | gosqr-partners |
| Наименование | Взаимодействие с Платформой цифрового взаимодействия ГосQR |
| Тип | Адаптер для межведомственного взаимодействия |
| Версия СМЭВ | СМЭВ3 |
| Версия ВС | 1.0.5 |
| Версия МР | 3.5 |
| Поставщик | Минцифры России |
| Потребители | МФЦ, Минцифры России |
Описание бизнес-процесса взаимодействия:
ИС клиента передает через Агредатор в СМЭВ запрос для взаимодействия с Платформой цифрового взаимодействия ГосQR. Платформа цифрового взаимодействия ГосQR получает из СМЭВ запрос и направляет обратно через СМЭВ в Агредатор запрошенную информацию. Агредатор направляет в ИС клиента полученную информацию.
flowchart LR;
A[ИС организации] <--> B[Агредатор];
B <--> C[СМЭВ];
C <--> D[ИС ГосQR];
Переменные окружения
| Название | Описание |
|---|---|
| CA_CERT | Сертификат центра сертификации для подключения к rabbitmq |
| CLIENT_CERT | Сертификат, используемый для подключения к rabbitmq |
| CLIENT_KEY | Ключ, используемый для подключения к rabbitmq |
| MQ_HOST | Хост rabbitmq |
| MQ_PORT | Порт rabbitmq |
| SMEV_SERVICE | Название c СМЭВ сервиса, на который будут отправляться запросы |
Переменные для конфигурирования подключения к БД:
DATABASE_HOST, DATABASE_PORT, DATABASE_NAME, DATABASE_USER, DATABASE_PASS.
Переменные для конфигурирования отправки метрик в Elasticsearch:
ELASTIC_HOST, ELASTIC_PORT, ELASTIC_METRIC_PREFIX.
Принимаемые параметры
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| env | Код маршрутизации. Для продуктивной среды: возможно только EPGU Для тестовой среды: EPGU - среда ЕПГУ-DEV UAT - среда ЕПГУ-UAT DEV2 - среда ЕПГУ-DEV2 SVCDEV - среда ЕПГУ-SVCDEV | + | EPGU |
| organizations | Информация о ЮЛ участнике взаимодействия с GosQR | -1 | Составной элемент Organizations |
| departments | Информация о подразделениях ЮЛ участника взаимодействия с GosQR | -1 | Составной элемент Departments |
| deal_types | Информация о шаблонах сделок | -1 | Составной элемент DealTypes |
| qr_codes | Работа с QR-кодами | -1 | Составной элемент QRcodes |
| deals | Управление сделками | -1 | Составной элемент Deals |
| is_mtom | Признак передачи вложения с запросом по протоколу MTOM (если файл больше 4 Мб). В противном случае считается, что вложение передается через файловое хранилище СМЭВ | - | true |
| attachments | Информация о переданных файлах вложениях, сохраненных в файловом хранилище Агредатора | - | Последовательность идентификаторов файлов вложений uuid. ["31625521a1f842575a3bc814cbc750dfc3017421966f634107699c8d71054f15", "181210f8f9c779c26da1d9b2075bde0127302ee0e3fca38c9a83f5b1dd8e5d3b"] |
1 - обязательно должен присутствовать только один из элементов
Вложения в запросе представляют из себя бизнес-данные запроса вида сведений в формате PDF и SIG. Ограничения на вкладываемые пользователем файлы: общий объём не более 99 Мб, количество файлов не ограничено. Способ передачи вложений – FTP, если файл больше 4 Мб, МТОМ, если файл меньше 4 Мб.
Структура элемента Organizations
Информация о ЮЛ участнике взаимодействия с GosQR
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| action | Цель запроса Значения: get - получить информацию об организации; create - добавление организации; update - обновление организации | + | get |
| organization_dto | Информация о ЮЛ участнике взаимодействия с GosQR | - | Составной элемент OrganizationDTO |
Структура элемента OrganizationDTO
Информация о ЮЛ участнике взаимодействия с GosQR
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| logo | Ссылка на логотип | - | |
| brand | Название бренда | + | Мосты |
| name | Название организации | + | ООО "Мосты" |
| name_on_main | Варианты отображения Юр. адреса true - отображать Юр. адрес на стартовом экране; false - отображать Юр. адрес в шторке | - | |
| legal_address | Адрес организации (ЮЛ) | + | г. Самара ул. Луначарского 5 |
| phone | Телефон организации | - | Массив составных элементов Phone |
| url | Адрес сайта ЮЛ | + | www.mosty.ru |
| additional | Дополнительная информация | - | Массив составных элементов Additional |
Структура элемента Phone
Телефон
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| title | Название поля Например: Бесплатный номер по России | + | Бесплатный номер по России |
| value | Значение | + | +78002356589 |
Структура элемента Additional
Дополнительная информация
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| title | Название Например: Страница вконтакте | + | Страница вконтакте |
| value | Значение | + | @mosty |
Структура элемента Departments
Информация о подразделениях ЮЛ участника взаимодействия с GosQR
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| action | Цель запроса Значения: get - получить информацию об подразделении; create - добавление подразделения; update - обновление подразделения | + | |
| modify_department_request | Запросы добавления и обновления подразделении организации участнике взаимодействия с GosQR | -1 | Массив составных элементов ModifyDepartmentRequest |
| get_departments_request | Получение данных по подразделениям | -1 | Составной элемент GetDepartmentsRequest |
1 - обязательно должен присутствовать только один из элементов
Структура элемента ModifyDepartmentRequest
Запросы добавления и обновления подразделении организации участнике взаимодействия с GosQR
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| external_department_id | Внешний идентификатор подразделения (для упрощения процесса роутинга внутри ИС) | + | 12547 |
| department_id | Идентификатор подразделения | - | |
| name | Наименование подразделения | + | Чкаловский Мост |
| workstation | АРМы | - | Массив составных элементов Workstation |
| location | Координаты подразделения | - | Составной элемент Location |
| department_address | Адрес подразделения | - | г. Тольяти Ленина 40 |
| phone | Телефон подразделения | + | Массив составных элементов Phone |
| timezone | Часовой пояс | + | Europe/Moscow |
Структура элемента Workstation
АРМ
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| id | Идентификатор (uuid) | + | |
| title | Название | + |
Структура элемента Location
Координаты подразделения
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| lat | широта | + | 80 |
| lon | долгота | + | 165 |
Структура элемента GetDepartmentsRequest
Получение данных по подразделениям
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| external_department_id | Внешний идентификатор подразделения (для упрощения процесса роутинга внутри ИС) | -1 | |
| page | Номер запрашиваемой страницы Default value: 0 | -1 | 2 |
| size | Размер страницы Default value: 20 | -1 | 10 |
1 - обязательно должен присутствовать или external_department_id, или (page и size)
Структура элемента DealTypes
Информация о шаблонах сделок
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| create_deal_type | Создание шаблонов сделки | -1 | Составной элемент DealTypeRequest |
| update_deal_type | Обновление шаблонов сделки | -1 | Составной элемент DealTypeRequest |
| get_deal_type_request | Запрос шаблона сделки по идентификатору | -1 | Составной элемент GetDealTypeRequest |
1 - обязательно должен присутствовать только один из элементов
Структура элемента DealTypeRequest
Шаблон сделки
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| id | Идентификатор шаблона сделки uuid. Используется при обновлении шаблона | -1 | |
| name | Название сделки для отображения пользователю. Используется при создании шаблона | -1 | Оформление SIM-карты |
| pin_title | Информация для экрана пин-кода (инструкция для пользователя) | - | Сообщите пин-код сотруднику и ожидайте дальнейших действий |
| footer | Футер для стартового экрана (доп информация для пользователя) | - | Может потребоваться документ, удостоверяющий личность |
| steps | Шаги сделки | + | Массив составных элементов Steps |
| deal_ttl | Срок действия сделки | + | 5000 |
1 - обязательно должен присутствовать только один из элементов
Структура элемента Steps
Шаги сделки
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| permission_step_create_dto | Шаблон получения согласия | -1 | Составной элемент PermissionStepCreateDTO |
| multi_permission_step_create_dto | Шаблон получения мультисогласия | -1 | Составной элемент MultiPermissionStepCreateDTO |
| gsm_template_step_create_dto | Шаблон документов для операторов сотовой связи | -1 | Составной элемент GsmTemplateStepCreateDTO |
| interrupt_step_create_dto | Шаблон прерывания сделки | -1 | Составной элемент InterruptStepCreateDTO |
| final_step_create_dto | Шаблон завершения сделки | -1 | Составной элемент FinalStepCreateDTO |
1 - обязательно должен присутствовать только один из элементов
Структура элемента PermissionStepCreateDTO
Шаблон получения согласия
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| sysname | Мнемоника согласия | + | PERS_DATA_EXT |
| expire | Срок истечения действия согласия в минутах | + | 1576800 |
| responsible_object | Лицо (сотрудник организации), осуществляющее обработку данных (строка с ФИО или другой информацией, переданная в запросе согласия - на усмотрение организации, запрашивающей согласие) | + | Иванов Иван Иванович |
| purposes | Перечень мнемоник целей | + | Составной элемент Purposes |
| actions | Перечень мнемоник действий | + | Составной элемент Actions |
| scopes | Перечень разрешений ЕСИА | + | Составной элемент Scopes |
Структура элемента Purposes
Перечень мнемоник целей
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| elements | + | Составной элемент Elements |
Структура элемента Elements
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| sysname | Массив мнемоник действия | + | [PERS_DATA_EXT] |
Структура элемента Actions
Перечень мнемоник действий
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| elements | + | Составной элемент Elements |
Структура элемента Scopes
Перечень разрешений ЕСИА
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| elements | + | Составной элемент Elements |
Структура элемента MultiPermissionStepCreateDTO
Шаблон получения мультисогласия
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| permissions | Массив согласий | + | Составной элемент Permissions |
Структура элемента Permissions
Массив согласий
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| permission | Описание согласия | + | Массив составных элементов Permission |
Структура элемента Permission
Описание согласия
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| ogrn | ОГРН | + | 1234567899874 |
| sysname | Мнемоника типа согласия | + | PERS_DATA_EXT |
| expire | Срок истечения действия согласия в минутах | + | 1576800 |
| responsible_object | Лицо (сотрудник организации), осуществляющее обработку данных (строка с ФИО или другой информацией, переданная в запросе согласия - на усмотрение организации, запрашивающей согласие) | + | Иванов Иван Иванович |
| purposes | Перечень мнемоник целей | + | Составной элемент Purposes |
| actions | Перечень мнемоник действий | + | Составной элемент Actions |
| scopes | Перечень разрешений ЕСИА | + | Составной элемент Scopes |
Структура элемента GsmTemplateStepCreateDTO
Шаблон документов для операторов сотовой связи
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| template_id | Идентификатор шаблона документа | + | GosQR1807 |
| business_data | Бизнес данные, необходимые для проведения сделки | + | Составной элемент BusinessData |
| person_data_list | Пользовательские данные | + | Составной элемент PersonDataList |
Структура элемента BusinessData
Бизнес данные, необходимые для проведения сделки
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| name_operator | Cокращенное наименование оператора | - | Cокращенное наименование оператора |
| place | Адрес оператора | - | Адрес оператора |
| bank_operator | Наименование банка оператора | - | Наименование банка оператора |
| ogrn | ОГРН | - | 1035009567450 |
| inn | ИНН | - | 770176611 |
| kpp | КПП | - | 77070100 |
| checking | Расчетный счет | - | 40702810855000008878 |
| bik | БИК | - | 77070100 |
| contract_name | Наименование договора | - | Договор |
| date_contract | Дата заключения договора | - | 12.02.2023 |
| id_simcard | Идентификатор сим-карты | - | 858586876 |
| contract_place | Место заключения договора | - | Новосибирск |
| tariff_plan | Тарифный план | - | тарифный план |
| new_number | Новый номер сим-карты | - | +7 999 999-99-91 |
| text_contract | Текст договора | - | текст контракта |
| agreement | Согласие | - | согласие пользователя |
| cod_manager | Код продавца оператора | - | 77070101 |
| partner_name | Наименование представителя | - | Представитель оператора |
| partner_fio | ФИО представителя оператора | - | Иванов Петр Сидорович |
| sale_point_code | Код точки продаж | - | Точка продаж 01 |
| proxy_number | Доверенность, номер | - | Доверенность 123 |
| proxy_date | Доверенность, дата выдачи | - | 10.09.2007 |
| sms_notification | Согласие на SMS информирование | - | true |
| advert_sending | Согласие на рекламу | - | true |
| personal_data_processing | Согласие на обработку ПДн | - | true |
| biometric_data | Согласие на биометрию | - | true |
| public_official | Являюсь публичным лицом | - | true |
| corr_account | Корреспондентский счет | - | 30101810145250000411 |
| contract_expire_date | Дата окончания действия договора | - | 10.09.2007 |
| add_info1 | Дополнительные параметры даты | - | 10.09.2007 |
| add_info2 | Дополнительные параметры даты | - | 10.09.2007 |
| add_info3 | Дополнительные параметры даты | - | 10.09.2007 |
| add_info4 | Дополнительные параметры даты | - | 10.09.2007 |
| add_info5 | Дополнительные параметры даты | - | 10.09.2007 |
| add_info6 | Дополнительные текстовые параметры | - | Дополнительные текстовые параметры |
| add_info7 | Дополнительные текстовые параметры | - | Дополнительные текстовые параметры |
| add_info8 | Дополнительные текстовые параметры | - | Дополнительные текстовые параметры |
| add_info9 | Дополнительные текстовые параметры | - | Дополнительные текстовые параметры |
| add_info10 | Дополнительные текстовые параметры | - | Дополнительные текстовые параметры |
| add_info11 | Дополнительные числовые параметры | - | 43534556567577 |
| add_info12 | Дополнительные числовые параметры | - | 43534556567577 |
| add_info13 | Дополнительные числовые параметры | - | 43534556567577 |
| add_info14 | Дополнительные числовые параметры | - | 43534556567577 |
| add_info15 | Дополнительные числовые параметры | - | 43534556567577 |
| add_info16 | Дополнительные текстовые параметры | - | Дополнительные текстовые параметры |
| add_info17 | Дополнительные текстовые параметры | - | Дополнительные текстовые параметры |
| add_info18 | Дополнительные текстовые параметры | - | Дополнительные текстовые параметры |
| add_info19 | Дополнительные текстовые параметры | - | Дополнительные текстовые параметры |
| add_info20 | Дополнительные текстовые параметры | - | Дополнительные текстовые параметры |
| name_disagreement1 | Текст согласия | - | Текст согласия |
| name_disagreement2 | Текст согласия | - | Текст согласия |
| name_disagreement3 | Текст согласия | - | Текст согласия |
| name_disagreement4 | Текст согласия | - | Текст согласия |
| confirmed_disagreement1 | Принятое согласие | - | true |
| confirmed_disagreement2 | Принятое согласие | - | true |
| confirmed_disagreement3 | Принятое согласие | - | true |
| confirmed_disagreement4 | Принятое согласие | - | true |
| codeword | Кодовая фраза | - | Кодовая фраза |
| is_deliverable | Признак необходимости доставки счетов клиенту | - | true |
| okpo | ОКПО | - | 31090505 |
Структура элемента PersonDataList
Пользовательские данные
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| person_data | Список персональных данных | - | ["lastName", "firstName", "middleName", "birthDate"] |
Структура элемента InterruptStepCreateDTO
Шаблон прерывания сделки
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| title | Значение по умолчанию: Оформление прервано | - | Оформление прервано |
| content | Значение по умолчанию: Ожидайте действий сотрудника | - | Уточните информацию у сотрудника |
| footer | Футер (доп информация для пользователя) | - | Бесплатная горячая линия - 8 800 700 0611 |
| back_url | URL, по которому будет производиться обратный переход во внешнее приложение | - | |
| error_url | URL, по которому будет производиться обратный переход во внешнее приложение в случае перевода сделки в статус error | - | |
| return_button | Наименование кнопки перехода | - |
Структура элемента FinalStepCreateDTO
Шаблон завершения сделки
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| title | Значение по умолчанию: Оформление успешно завершено | - | Оформление успешно завершено |
| content | Значение по умолчанию: Ожидайте дальнейших действий сотрудника | - | Ожидайте дальнейших действий от сотрудника |
| footer | Футер (доп информация для пользователя) | - | Бесплатная горячая линия - 8 800 700 0611 |
| back_url | URL, по которому будет производиться обратный переход во внешнее приложение | - | |
| error_url | URL, по которому будет производиться обратный переход во внешнее приложение в случае перевода сделки в статус error | - | |
| return_button | Наименование кнопки перехода | - |
Структура элемента GetDealTypeRequest
Запрос шаблона сделки по идентификатору
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| id | Идентификатор сделки uuid | -1 | 97206458-cfd7-4117-ba5c-6429982ffcf4 |
| page | Индекс страницы с отсчетом от нуля (0..N) | -1 | 1 |
| size | Размер возвращаемой страницы. Default value: 50 | -1 | 10 |
1 - обязательно должен присутствовать или id, или (page и size)
Структура элемента QRcodes
Работа с QR-кодами
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| create_qr_request | -1 | Составной элемент CreateQRRequest | |
| get_qr_request | -1 | Составной элемент GetQRRequest |
1 - обязательно должен присутствовать только один из элементов
Структура элемента CreateQRRequest
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| department_id | Внутренний идентификатор подразделения | + | 296f2580-62cd-41bb-aa64-5fe0e5716bd7 |
| qr_ttl | Время жизни динамического QR (в минутах) | - | 2 |
| deal_type | Массив идентификаторов шаблонов сделки | + | [6f867b43-ab74-4247-a533-177a39cb55f8] |
| workstation | АРМ | - | Составной элемент Workstation |
| qr_type | Тип кода. Значения: - динамический (dynamic), - статический (static) | + | static |
| additional | Дополнительная информация | - | |
| scan_id | Идентификатор сканирования ТОТР | - | |
| version | Версия QR-кода | - |
Структура элемента GetQRRequest
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| department_id | Идентификатор подразделения | + | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| page | Индекс страницы с отсчетом от нуля (0..N) | -1 | 1 |
| size | Размер возвращаемой страницы Default value: 50 | -1 | 10 |
1 - необязательно, но в случае присутствия должны быть оба (page и size)
Структура элемента Deals
Управление сделками
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| upload_file_deal_request | + | Составной элемент UploadFileDealRequest | |
| add_steps_deal_request | + | Составной элемент AddStepsDealRequest | |
| download_file_deal_request | + | Составной элемент DownloadFileDealRequest | |
| get_deal_request | + | Составной элемент GetDealRequest | |
| get_agile_deal_request | + | Составной элемент GetAgileDealRequest | |
| get_pins_deal_request | + | Составной элемент GetPinsDealRequest |
Структура элемента UploadFileDealRequest
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| transaction_id | Идентификатор транзакции | + | e9080ade-c05f-4928-b9b1-3618a00d2796 |
| file_name | Наименование файла | + | Example.sig |
| mime_type | Тип (формат) файла | + | application/x-pkcs7-signature |
Структура элемента AddStepsDealRequest
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| transaction_id | Идентификатор транзакции | + | e9080ade-c05f-4928-b9b1-3618a00d2796 |
| steps | Шаги | + | Массив составных элементов Steps |
Структура элемента DownloadFileDealRequest
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| transaction_id | Идентификатор транзакции | + | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| file_id | Идентификатор переданного файла | + | e9080ade-c05f-4928-b9b1-3618a00d2796 |
Структура элемента GetDealRequest
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| transaction_id | Идентификатор сделки | + | e9080ade-c05f-4928-b9b1-3618a00d2796 |
Структура элемента GetAgileDealRequest
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| guid | Идентификатор QR-кода | + | 00ed429b-7db5-433f-9774-67a0bf68ad13 |
| pin | Пин-код пользователя для связывания данных пользователя и данных сделки | + | 1478 |
Структура элемента GetPinsDealRequest
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| guid | Идентификатор QR-кода | + | 00ed429b-7db5-433f-9774-67a0bf68ad13 |
| page | Индекс страницы с отсчетом от нуля (0..N) | -1 | 1 |
| size | Размер возвращаемой страницы Default value: 50 | -1 | 2 |
1 - необязательно, но в случае присутствия должны быть оба (page и size)
Параметры ответа
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| organizations | Информация о ЮЛ участнике взаимодействия с GosQR | -1 | Составной элемент OrganizationsT |
| departments | Информация о подразделениях ЮЛ участника взаимодействия с GosQR | -1 | Составной элемент DepartmentsT |
| deal_types | Информация о шаблонах сделок | -1 | Составной элемент DealTypesT |
| qr_codes | Работа с QR-кодами | -1 | Составной элемент QRcodesT |
| deals | Управление сделками | -1 | Составной элемент DealsT |
| attachments | Информация о переданных файлах-вложениях, сохраненных в файловом хранилище Агредатора | - | Массив составных элементов AggredatorAttachment |
1 - обязательно должен присутствовать только один из элементов
Вложение в ответе вида сведений является договор оказания услуг, формат файла – PDF (заверенный электронной подписью) и SIG.
Структура элемента OrganizationsT
Информация о ЮЛ участнике взаимодействия с GosQR
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| organization_dto | Информация о ЮЛ участнике взаимодействия с GosQR | -1 | Составной элемент OrganizationDTO |
| fault_response | ошибка | -1 | Составной элемент FaultResponse |
1 - обязательно должен присутствовать только один из элементов
Структура элемента FaultResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| fault_code | Код ошибки | + | 500 |
| fault_message | Описание ошибки | + | Внутренняя ошибка |
Структура элемента DepartmentsT
Информация о подразделениях ЮЛ участника взаимодействия с GosQR
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| department_response | -1 | Массив составных элементов DepartmentResponse | |
| fault_response | ошибка | -1 | Составной элемент FaultResponse |
1 - обязательно должен присутствовать только один из элементов
Структура элемента DepartmentResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| external_department_id | Внешний идентификатор подразделения (для упрощения процесса роутинга внутри ИС) | + | 12547 |
| department_id | Внутренний идентификатор подразделения | + | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| name | Название подразделения | + | Чкаловский Мост |
| workstation | АРМы | - | Массив составных элементов Workstation |
| location | Координаты подразделения | - | Составной элемент Location |
| department_address | Адрес подразделения | - | г. Тольяти Ленина 40 |
| phone | Телефон | + | Массив составных элементов Phone |
| timezone | Часовой пояс | + | Europe/Moscow |
Структура элемента DealTypesT
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| deal_type_response | -1 | Составной элемент DealTypeResponse | |
| deal_type_lite_response | -1 | Массив составных элементов (0..unbounded) DealTypeLiteResponse | |
| fault_response | ошибка | -1 | Составной элемент FaultResponse |
1 - обязательно должен присутствовать только один из элементов
Структура элемента DealTypeResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| id | Идентификатор шаблона сделки uuid | + | 97206458-cfd7-4117-ba5c-6429982ffcf4 |
| name | Название сделки для отображения пользователю | + | Оформление SIM-карты |
| deal_ttl | Срок действия сделки в минутах | + | 5000 |
| pin_title | Информация для экрана пин-кода (инструкция для пользователя) | - | Сообщите пин-код сотруднику и ожидайте дальнейших действий |
| footer | Футер для стартового экрана (доп информация для пользователя) | - | Может потребоваться документ, удостоверяющий личность |
| steps | Шаги сделки | - | Массив составных элементов Steps |
Структура элемента DealTypeLiteResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| id | Идентификатор сделки uuid | + | 97206458-cfd7-4117-ba5c-6429982ffcf4 |
| name | Название сделки для отображения пользователю | + | Оформление SIM-карты |
Структура элемента QRcodesT
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| qr_response | -1 | Массив составных элементов (0..unbounded) QRResponse | |
| fault_response | ошибка | -1 | Составной элемент FaultResponse |
1 - обязательно должен присутствовать только один из элементов
Структура элемента QRResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| guid | Идентификатор QR-кода | + | 15108574-d50e-4d71-80aa-e0786e827164 |
| base64_image | Изображение QR-кода | + | iVBORw0KGgoAAAANSUhEUgAAAMgAAADIAQAAAACFI5MzAAABwUlEQVR4Xu2WW2rEMAxFBd6WQVs3aFuG9B6FJmFo/6T2JyLziM+AXlea2PGb2efBZS95CfaXZJmNI5b5njYi8raDhK6IrdMtOLjtIYu7NT32OPQ9b5sI15zjII5Osv3YY00zjz4ClHe9O5k+KlpKkETc9qGdOoJtUjyW4/u0erJsLJsqKS+zOfXZQTC1zXz5SqFYD5HXsZxcz87dCikmLq+ORpSrRvnOtJrIqWQonWiwlPMjgkqSLePDJitQAX1HUEzkXFtiU07JXUlfii8lykvpUUtGTOsidV9PxHSYEiHbZ0VLyVbH0J+WudLU6VXRYuKqqQIYJI0Or4oWE+1vVJ9jFSz1K9NSkrmm4olGv+NLA4lUBT9AhpL/VdFiogxzdNVApsv4l+ogWkjIPNh80n6qpIHgf6L4cc4WomwhlFHzRNt0/tiwtSSQB1FI6pse7lshpeT885PbFKMCuWtdSzwvHrdS74AGgtEslVLi4DmlhyycqpiONIJdQb71JLgoaSD27+euBrJQuZNtDrBl/5rIeS41asAobxvZ7HOtJfXvI4IyklBPXNKho0dOGkgq5Mi2ke+6I6glP9tLXoL9P/kCai1Vu+XxTkwAAAAASUVORK5CYII= |
| link | Ссылка, содержащаяся в QR-коде диплинк/guid | + | https://l11.epgu-front.test.gosuslugi.ru/gos-qr/15108574-d50e-4d71-80aa-e0786e827164 |
| deal_type | Данные шаблона сделки | + | Массив составных элементов DealType |
| transaction_id | Идентификатор сделки (только для qrType = dynamic) | - | 5ef0381d-0cb3-42b5-bf4b-960352d5d9db |
| workstation | АРМ | - | Составной элемент Workstation |
| additional | Дополнительная информация | - | |
| scan_id | Идентификатор сканирования ТОТР | - | |
| version | Версия QR-кода | - |
Структура элемента DealType
Данные шаблона сделки
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| deal_type_id | Идентификатор сделки uuid | + | 89b12df2-4010-4317-a5ea-0adbe26c1666 |
| name | Название сделки для отображения пользователю | + | Оформление SIM-карты |
| pin_title | Информация для экрана пин-кода (инструкция для пользователя) | - | Сообщите пин-код сотруднику и ожидайте дальнейших действий |
| footer | Футер для стартового экрана (доп информация для пользователя) | - | Может потребоваться документ, удостоверяющий личность |
Структура элемента DealT
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| upload_file_deal_response | -1 | Составной элемент UploadFileDealResponse | |
| deal_response | -1 | Составной элемент DealResponse | |
| get_agile_deal_response | -1 | Составной элемент GetAgileDealResponse | |
| get_pins_deal_response | -1 | Массив составных элементов GetPinsDealResponse | |
| result | Результат операции. Значение: success | -1 | success |
| fault_response | ошибка | -1 | Составной элемент FaultResponse |
1 - обязательно должен присутствовать только один из элементов
Структура элемента UploadFileDealResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| file_id | Идентификатор переданного файла | + | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
Структура элемента DealResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| status | Статус сделки | + | cancelled |
| steps | Шаги сделки | + | Массив составных элементов StepsT |
| deal_type | Идентификатор шаблона сделки | + | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| expires | Время жизни сделки | + | 259199998 |
| index | Номер текущего шага | + | 0 |
| error_message | Описание ошибки | - |
Структура элемента StepsT
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| status | Cтатус шага | + | interrupted |
| data | + | Составной элемент Data |
Структура элемента Data
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| permission_step_response | -1 | Составной элемент PermissionStepResponse | |
| multi_permission_step_response | -1 | Составной элемент MultiPermissionStepResponse | |
| gsm_template_step_response | -1 | Составной элемент GsmTemplateStepResponse | |
| interrupt_step_response | -1 | Составной элемент InterruptStepResponse | |
| final_step_response | -1 | Составной элемент FinalStepResponse |
1 - обязательно должен присутствовать только один из элементов
Структура элемента PermissionStepResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| sysname | Мнемоника типа согласия | + | PERS_DATA_EXT |
| expire | Срок истечения действия согласия в минутах | + | 1576800 |
| responsible_object | Лицо (сотрудник организации), осуществляющее обработку данных (строка с ФИО или другой информацией, переданная в запросе согласия - на усмотрение организации, запрашивающей согласие) | + | Иванов Иван Иванович |
| purposes | Перечень мнемоник целей | + | Составной элемент Purposes |
| actions | Перечень мнемоник действий | + | Составной элемент Actions |
| scopes | Перечень разрешений ЕСИА | + | Составной элемент Scopes |
| iss_perm_id | Идентификатор согласия | - | 456578 |
| oid | Идентификатор пользователя в ЕСИА | - | 107000455 |
Структура элемента MultiPermissionStepResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| oid | Идентификатор пользователя в ЕСИА | - | |
| permissions | Массив согласий | + | Массив составных элементов PermissionT |
Структура элемента PermissionT
Описание согласия
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| ogrn | ОГРН | + | |
| sysname | Мнемоника типа согласия | + | |
| expire | Срок истечения действия согласия в минутах | + | |
| responsible_object | Лицо (сотрудник организации), осуществляющее обработку данных (строка с ФИО или другой информацией, переданная в запросе согласия - на усмотрение организации, запрашивающей согласие) | + | |
| purposes | Перечень мнемоник целей | + | Составной элемент Purposes |
| actions | Перечень мнемоник действий | + | Составной элемент Actions |
| scopes | Перечень разрешений ЕСИА | + | Составной элемент Scopes |
| iss_perm_id | Идентификатор согласия | - |
Структура элемента GsmTemplateStepResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| id_pdf | Идентификатор файла договора в формате PDF | - | |
| id_sig | Идентификатор файла подписи ФЛ | - | |
| oid | Идентификатор пользователя в ЕСИА | - | |
| iss_perm_id | Идентификатор согласия в платформе согласий | - | |
| status | Состояние согласия | - | |
| status_code | Код сообщения статуса загрузки файла подписи | - | |
| session_id | Идентификатор сделки | - | |
| sysname | Мнемоника согласия | - | |
| name | Название согласия | - | |
| description | Описание согласия | - | |
| person_data | Список персональных данных | - | Составной элемент PersonData |
| error_code | Код ошибки | - |
Структура элемента PersonData
Список персональных данных
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| last_name | Фамилия | - | |
| first_name | Имя | - | |
| middle_name | Отчество | - | |
| birth_date | Дата рождения | - | |
| birth_place | Место рождения | - | |
| nation | - | ||
| document | Документ удостоверяющий личность | - | |
| series | Серия документа | - | |
| number | Номер документа | - | |
| date | Дата выдачи документа | - | |
| issued | Кем выдан документ | - | |
| code | Код подразделения | - | |
| locality | Адрес проживания | - | |
| reg_address | Адрес регистрации | - | |
| phone | Телефон | - | |
| Электронный адрес | - | ||
| area | Район | - | |
| city | Город | - | |
| region | Регион | - | |
| street | Улица | - | |
| house | Дом | - | |
| house_type | Тип дома | - | |
| flat | Квартира | - | |
| zip_code | Индекс | - | |
| settlement | Поселение | - | |
| stead | Участок | - | |
| stead_type | Тип участка | - | |
| frame | Корпус/литера | - | |
| frame_type | Тип корпуса/литеры | - | |
| building | Строение | - | |
| room | Комната | - | |
| fias_code | Код ФИАС | - |
Структура элемента InterruptStepResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| title | Значение по умолчанию: Оформление прервано | - | Оформление прервано |
| content | Значение по умолчанию: Ожидайте действий сотрудника | - | Уточните информацию у сотрудника |
| footer | Футер (доп информация для пользователя) | - | Бесплатная горячая линия - 8 800 700 0611 |
| back_url | URL, по которому будет производиться обратный переход во внешнее приложение | - | |
| error_url | URL, по которому будет производиться обратный переход во внешнее приложение в случае перевода сделки в статус error | - | |
| return_button | Наименование кнопки перехода | - |
Структура элемента FinalStepResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| title | Значение по умолчанию: Оформление успешно завершено | - | |
| content | Значение по умолчанию: Ожидайте дальнейших действий сотрудника | - | |
| footer | Футер (доп информация для пользователя) | - | |
| back_url | URL, по которому будет производиться обратный переход во внешнее приложение | - | |
| error_url | URL, по которому будет производиться обратный переход во внешнее приложение в случае перевода сделки в статус error | - | |
| return_button | Наименование кнопки перехода | - |
Структура элемента GetAgileDealResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| transaction_id | Идентификатор сделки | + | c5bb377b-dd24-4075-8f55-8880e3ea8649 |
Структура элемента GetPinsDealResponse
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| pin | Пин-код пользователя для связывания данных пользователя и данных сделки | + | 1478 |
| created | Дата и время создания пин-кода | + | 1697468270 |
Структура элемента AggredatorAttachment
| Параметр | Описание | Обязательное | Пример |
|---|---|---|---|
| uuid | Идентификатор файла в хранилище | + | 4833e4c4385dc47f2d2a08469f246e7cd1f66f416691d0b5a92a00d722f8d4ec |
| checksum | Контрольная сумма | + | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 |
| created_at | Время загрузки файла | + | 2020-11-16T12:27:20.726+03:00 |
| tags | Последовательность строк-тегов файла | + | ["test"] |
| metadata | Метаданные | + | {} |
| delete_at | Время, когда файл будет удален из хранилища. В случае, если значение равно null - файл не будет удален | + | null |
| filename | Имя загруженного файла | + | test.txt |
| store | Хранилище, в котором хранится файл | + | db |
| identifier_in_store | Идентификатор файла в хранилище | + | 4833e4c4385dc47f2d2a08469f246e7cd1f66f416691d0b5a92a00d722f8d4ec |
| smev_id | Идентификатор вложения, используемый в СМЭВ конверте | + | attachment.txt |
Примеры
Для проверки настройки сервиса можно в консоли отправки панели администрирования отправить запрос, соответствующий контрольному примеру, и получить соответствующий ответ.
Сценарий 0
Запрос
{
"env": "EPGU",
"organizations": {
"action": "get"
}
}
Ответ
{
"organizations": {
"organization_dto": {
"brand": "Мосты",
"name": "ООО \"Мосты\"",
"legal_address": "г. Самара ул. Луначарского 5",
"phone": [
{
"title": "Бесплатный номер организации",
"value": "88003558896"
}
],
"url": "https://www.mosty.ru",
"additional": [
{
"title": "Страница вконтакте",
"value": "https://vk.com/@mosty"
},
{
"title": "Страница однокласники",
"value": "https://ok.ru/@mosty"
}
]
}
}
}
Сценарий 1
Запрос
{
"env": "EPGU",
"organizations": {
"action": "create",
"organization_dto": {
"brand": "Мосты",
"name": "ООО \"Мосты\"",
"legal_address": "г. Самара ул. Луначарского 5",
"url": "www.mosty.ru",
"additional": [
{
"title": "Страница вконтакте",
"value": "@mosty"
}
]
}
}
}
Ответ
{
"organizations": {
"organization_dto": {
"brand": "Мосты",
"name": "ООО \"Мосты\"",
"legal_address": "г. Самара ул. Луначарского 5",
"url": "www.mosty.ru",
"additional": [
{
"title": "Страница вконтакте",
"value": "@mosty"
}
]
}
}
}
Сценарий 2
Запрос
{
"env": "EPGU",
"organizations": {
"action": "update",
"organization_dto": {
"brand": "Мосты",
"name": "ООО \"Мосты\"",
"legal_address": "г. Самара ул. Луначарского 5",
"url": "www.mosty.ru",
"additional": [
{
"title": "Страница вконтакте",
"value": "@mosty"
}
]
}
}
}
Ответ
{
"organizations": {
"organization_dto": {
"brand": "Мосты",
"name": "ООО \"Мосты\"",
"legal_address": "г. Самара ул. Луначарского 5",
"url": "www.mosty.ru",
"additional": [
{
"title": "Страница вконтакте",
"value": "@mosty"
}
]
}
}
}
Сценарий 3
Запрос
{
"env": "EPGU",
"departments": {
"action": "create",
"modify_department_request": [
{
"external_department_id": "12547",
"name": "Чкаловский Мост",
"location": {
"lat": "80",
"lon": "165"
},
"department_address": "г. Тольяти Ленина 40",
"phone": [
{
"title": "Бесплатный номер по России",
"value": "+78002356589"
}
],
"timezone": "Europe/Moscow"
}
]
}
}
Ответ
{
"departments": {
"department_response": [
{
"external_department_id": "12547",
"department_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Чкаловский Мост",
"location": {
"lat": "80",
"lon": "165"
},
"department_address": "г. Тольяти Ленина 40",
"phone": [
{
"title": "Бесплатный номер по России",
"value": "+78002356589"
}
],
"timezone": "Europe/Moscow"
}
]
}
}
Сценарий 4
Запрос
{
"env": "EPGU",
"departments": {
"action": "update",
"modify_department_request": [
{
"external_department_id": "12549",
"department_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Чкаловский Мост",
"location": {
"lat": "80",
"lon": "165"
},
"department_address": "г. Тольяти Ленина 40",
"phone": [
{
"title": "Бесплатный номер по России",
"value": "+78002356589"
},
{
"title": "Бесплатный дополнительный номер по России",
"value": "+78002876590"
}
],
"timezone": "Europe/Moscow"
}
]
}
}
Ответ
{
"departments": {
"department_response": [
{
"external_department_id": "12549",
"department_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Чкаловский Мост",
"location": {
"lat": "80",
"lon": "165"
},
"department_address": "г. Тольяти Ленина 40",
"phone": [
{
"title": "Бесплатный номер по России",
"value": "+78002356589"
},
{
"title": "Бесплатный дополнительный номер по России",
"value": "+78002876590"
}
],
"timezone": "Europe/Moscow"
}
]
}
}
Сценарий 5
Запрос
{
"env": "EPGU",
"departments": {
"action": "get",
"get_departments_request": {
"external_department_id": "12547"
}
}
}
Ответ
{
"departments": {
"department_response": [
{
"external_department_id": "12547",
"department_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Чкаловский Мост",
"location": {
"lat": "-80",
"lon": "165"
},
"department_address": "г. Тольяти Ленина 40",
"phone": [
{
"title": "Бесплатный номер по России",
"value": "+78002356589"
}
],
"timezone": "Europe/Moscow"
}
]
}
}
Сценарий 6
Запрос
{
"env": "EPGU",
"departments": {
"action": "get",
"get_departments_request": {
"page": "2",
"size": "10"
}
}
}
Ответ
{
"departments": {
"department_response": [
{
"external_department_id": "12547",
"department_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Чкаловский Мост",
"location": {
"lat": "-80",
"lon": "165"
},
"department_address": "г. Тольяти Ленина 40",
"phone": [
{
"title": "Бесплатный номер по России",
"value": "+78002356589"
}
],
"timezone": "UTC/GMT +4 hours"
},
{
"external_department_id": "65478",
"department_id": "4ee8ff17-f8c1-4f7d-aa47-cf8fcacfc1e8",
"name": "Макаровский Мост",
"location": {
"lat": "45",
"lon": "115"
},
"department_address": "г. Екатеринбург пер. Красный 2а",
"phone": [
{
"title": "Бесплатный номер по России",
"value": "+78002350055"
}
],
"timezone": "Asia/Yekaterinburg"
}
]
}
}
Сценарий 7
Запрос
{
"env": "EPGU",
"deal_types": {
"create_deal_type": {
"name": "Оформление SIM-карты",
"pin_title": "Сообщите пин-код сотруднику и ожидайте дальнейших действий",
"footer": "Может потребоваться документ, удостоверяющий личность",
"steps": [
{
"permission_step_create_dto": {
"sysname": "PERS_DATA_EXT",
"expire": "1576800",
"responsible_object": "Иванов Иван Иванович",
"purposes": {
"elements": {
"sysname": [
"PERS_DATA_EXT"
]
}
},
"actions": {
"elements": {
"sysname": [
"SHARE_DATA"
]
}
},
"scopes": {
"elements": {
"sysname": [
"mobile_ext"
]
}
}
}
},
{
"multi_permission_step_create_dto": {
"permissions": {
"permission": [
{
"ogrn": "1234567899874",
"sysname": "PERS_DATA_EXT",
"expire": "1576800",
"responsible_object": "Иванов Иван Иванович",
"purposes": {
"elements": {
"sysname": [
"PERS_DATA_EXT"
]
}
},
"actions": {
"elements": {
"sysname": [
"SHARE_DATA"
]
}
},
"scopes": {
"elements": {
"sysname": [
"mobile_ext"
]
}
}
},
{
"ogrn": "9876543214569",
"sysname": "PERS_DATA_EXT",
"expire": "1576800",
"responsible_object": "Иванов Иван Иванович",
"purposes": {
"elements": {
"sysname": [
"PERS_DATA_EXT"
]
}
},
"actions": {
"elements": {
"sysname": [
"SHARE_DATA"
]
}
},
"scopes": {
"elements": {
"sysname": [
"mobile_ext"
]
}
}
}
]
}
}
},
{
"gsm_template_step_create_dto": {
"template_id": "GosQR1807",
"business_data": {
"name_operator": "Cокращенное наименование оператора",
"place": "Адрес оператора",
"bank_operator": "Наименование банка оператора",
"ogrn": "1035009567450",
"inn": "770176611",
"kpp": "77070100",
"checking": "40702810855000008878",
"bik": "77070100",
"contract_name": "Договор",
"date_contract": "12.02.2023",
"id_simcard": "858586876",
"contract_place": "Новосибирск",
"tariff_plan": "тарифный план",
"new_number": "+7 999 999-99-91",
"text_contract": "текст контракта",
"agreement": "согласие пользователя",
"cod_manager": "77070101",
"partner_name": "Представитель оператора",
"partner_fio": "Иванов Петр Сидорович",
"sale_point_code": "Точка продаж 01",
"proxy_number": "Доверенность 123",
"proxy_date": "10.09.2007",
"sms_notification": "true",
"advert_sending": "true",
"personal_data_processing": "true",
"biometric_data": "true",
"public_official": "true",
"corr_account": "30101810145250000411",
"contract_expire_date": "10.09.2007",
"add_info1": "10.09.2007",
"add_info2": "10.09.2007",
"add_info3": "10.09.2007",
"add_info4": "10.09.2007",
"add_info5": "10.09.2007",
"add_info6": "Дополнительные текстовые параметры",
"add_info7": "Дополнительные текстовые параметры",
"add_info8": "Дополнительные текстовые параметры",
"add_info9": "Дополнительные текстовые параметры",
"add_info10": "Дополнительные текстовые параметры",
"add_info11": "43534556567577",
"add_info12": "43534556567577",
"add_info13": "43534556567577",
"add_info14": "43534556567577",
"add_info15": "43534556567577",
"add_info16": "Дополнительные текстовые параметры",
"add_info17": "Дополнительные текстовые параметры",
"add_info18": "Дополнительные текстовые параметры",
"add_info19": "Дополнительные текстовые параметры",
"add_info20": "Дополнительные текстовые параметры",
"name_disagreement1": "Текст согласия",
"name_disagreement2": "Текст согласия",
"name_disagreement3": "Текст согласия",
"name_disagreement4": "Текст согласия",
"confirmed_disagreement1": "true",
"confirmed_disagreement2": "true",
"confirmed_disagreement3": "true",
"confirmed_disagreement4": "true",
"codeword": "Кодовая фраза",
"is_deliverable": "true",
"okpo": "31090505"
},
"person_data_list": {
"person_data": [
"lastName",
"firstName",
"middleName",
"birthDate",
"birthPlace",
"document",
"series",
"number",
"date",
"issued",
"code",
"locality",
"regAddress",
"phone",
"email",
"area",
"city",
"region",
"street",
"house",
"flat",
"zipCode",
"settlement",
"stead",
"steadType",
"frame",
"frameType",
"building",
"room",
"houseType",
"fiasCode"
]
}
}
},
{
"final_step_create_dto": {
"title": "Оформление успешно завершено",
"content": "Ожидайте дальнейших действий от сотрудника",
"footer": "Бесплатная горячая линия - 8 800 700 0611"
}
}
],
"deal_ttl": "5000"
}
}
}
Ответ
{
"deal_types": {
"deal_type_response": {
"id": "97206458-cfd7-4117-ba5c-6429982ffcf4",
"name": "Оформление SIM-карты",
"deal_ttl": "5000",
"pin_title": "Сообщите пин-код сотруднику и ожидайте дальнейших действий",
"footer": "Может потребоваться документ, удостоверяющий личность",
"steps": [
{
"permission_step_create_dto": {
"sysname": "PERS_DATA_EXT",
"expire": "1576800",
"responsible_object": "Иванов Иван Иванович",
"purposes": {
"elements": {
"sysname": [
"PERS_DATA_EXT"
]
}
},
"actions": {
"elements": {
"sysname": [
"SHARE_DATA"
]
}
},
"scopes": {
"elements": {
"sysname": [
"mobile_ext"
]
}
}
}
},
{
"multi_permission_step_create_dto": {
"permissions": {
"permission": [
{
"ogrn": "1234567899874",
"sysname": "PERS_DATA_EXT",
"expire": "1576800",
"responsible_object": "Иванов Иван Иванович",
"purposes": {
"elements": {
"sysname": [
"PERS_DATA_EXT"
]
}
},
"actions": {
"elements": {
"sysname": [
"SHARE_DATA"
]
}
},
"scopes": {
"elements": {
"sysname": [
"mobile_ext"
]
}
}
},
{
"ogrn": "9876543214569",
"sysname": "PERS_DATA_EXT",
"expire": "1576800",
"responsible_object": "Иванов Иван Иванович",
"purposes": {
"elements": {
"sysname": [
"PERS_DATA_EXT"
]
}
},
"actions": {
"elements": {
"sysname": [
"SHARE_DATA"
]
}
},
"scopes": {
"elements": {
"sysname": [
"mobile_ext"
]
}
}
}
]
}
}
},
{
"gsm_template_step_create_dto": {
"template_id": "GosQR1807",
"business_data": {
"name_operator": "Cокращенное наименование оператора",
"place": "Адрес оператора",
"bank_operator": "Наименование банка оператора",
"ogrn": "1035009567450",
"inn": "770176611",
"kpp": "77070100",
"checking": "40702810855000008878",
"bik": "77070100",
"contract_name": "Договор",
"date_contract": "12.02.2023",
"id_simcard": "858586876",
"contract_place": "Новосибирск",
"tariff_plan": "тарифный план",
"new_number": "+7 999 999-99-91",
"text_contract": "текст контракта",
"agreement": "согласие пользователя",
"cod_manager": "77070101",
"partner_name": "Представитель оператора",
"partner_fio": "Иванов Петр Сидорович",
"sale_point_code": "Точка продаж 01",
"proxy_number": "Доверенность 123",
"proxy_date": "10.09.2007",
"sms_notification": "true",
"advert_sending": "true",
"personal_data_processing": "true",
"biometric_data": "true",
"public_official": "true",
"corr_account": "30101810145250000411",
"contract_expire_date": "10.09.2007",
"add_info1": "10.09.2007",
"add_info2": "10.09.2007",
"add_info3": "10.09.2007",
"add_info4": "10.09.2007",
"add_info5": "10.09.2007",
"add_info6": "Дополнительные текстовые параметры",
"add_info7": "Дополнительные текстовые параметры",
"add_info8": "Дополнительные текстовые параметры",
"add_info9": "Дополнительные текстовые параметры",
"add_info10": "Дополнительные текстовые параметры",
"add_info11": "43534556567577",
"add_info12": "43534556567577",
"add_info13": "43534556567577",
"add_info14": "43534556567577",
"add_info15": "43534556567577",
"add_info16": "Дополнительные текстовые параметры",
"add_info17": "Дополнительные текстовые параметры",
"add_info18": "Дополнительные текстовые параметры",
"add_info19": "Дополнительные текстовые параметры",
"add_info20": "Дополнительные текстовые параметры",
"name_disagreement1": "Текст согласия",
"name_disagreement2": "Текст согласия",
"name_disagreement3": "Текст согласия",
"name_disagreement4": "Текст согласия",
"confirmed_disagreement1": "true",
"confirmed_disagreement2": "true",
"confirmed_disagreement3": "true",
"confirmed_disagreement4": "true",
"codeword": "Кодовая фраза",
"is_deliverable": "true",
"okpo": "31090505"
},
"person_data_list": {
"person_data": [
"lastName",
"firstName",
"middleName",
"birthDate",
"birthPlace",
"document",
"series",
"number",
"date",
"issued",
"code",
"locality",
"regAddress",
"phone",
"email",
"area",
"city",
"region",
"street",
"house",
"flat",
"zipCode",
"settlement",
"stead",
"steadType",
"frame",
"frameType",
"building",
"room",
"houseType",
"fiasCode"
]
}
}
},
{
"final_step_create_dto": {
"title": "Оформление успешно завершено",
"content": "Ожидайте дальнейших действий от сотрудника",
"footer": "Бесплатная горячая линия - 8 800 700 0611"
}
}
]
}
}
}
Сценарий 8
Запрос
{
"env": "EPGU",
"deal_types": {
"update_deal_type": {
"id": "97206458-cfd7-4117-ba5c-6429982ffcf4",
"pin_title": "Сообщите пин-код сотруднику и ожидайте дальнейших действий",
"footer": "Может потребоваться документ, удостоверяющий личность",
"steps": [
{
"permission_step_create_dto": {
"sysname": "PERS_DATA_EXT",
"expire": "1576800",
"responsible_object": "Иванов Иван Иванович",
"purposes": {
"elements": {
"sysname": [
"PERS_DATA_EXT"
]
}
},
"actions": {
"elements": {
"sysname": [
"SHARE_DATA"
]
}
},
"scopes": {
"elements": {
"sysname": [
"mobile_ext"
]
}
}
}
},
{
"final_step_create_dto": {
"title": "Оформление успешно завершено",
"content": "Ожидайте дальнейших действий от сотрудника",
"footer": "Бесплатная горячая линия - 8 800 700 0611"
}
}
],
"deal_ttl": "5000"
}
}
}
Ответ
{
"deal_types": {
"deal_type_response": {
"id": "97206458-cfd7-4117-ba5c-6429982ffcf4",
"name": "Оформление SIM-карты",
"deal_ttl": "5000",
"pin_title": "Сообщите пин-код сотруднику и ожидайте дальнейших действий",
"footer": "Может потребоваться документ, удостоверяющий личность",
"steps": [
{
"permission_step_create_dto": {
"sysname": "PERS_DATA_EXT",
"expire": "1576800",
"responsible_object": "Иванов Иван Иванович",
"purposes": {
"elements": {
"sysname": [
"PERS_DATA_EXT"
]
}
},
"actions": {
"elements": {
"sysname": [
"SHARE_DATA"
]
}
},
"scopes": {
"elements": {
"sysname": [
"mobile_ext"
]
}
}
}
},
{
"final_step_create_dto": {
"title": "Оформление успешно завершено",
"content": "Ожидайте дальнейших действий от сотрудника",
"footer": "Бесплатная горячая линия - 8 800 700 0611"
}
}
]
}
}
}
Сценарий 9
Запрос
{
"env": "EPGU",
"deal_types": {
"get_deal_type_request": {
"id": "97206458-cfd7-4117-ba5c-6429982ffcf4"
}
}
}
Ответ
{
"deal_types": {
"deal_type_response": {
"id": "97206458-cfd7-4117-ba5c-6429982ffcf4",
"name": "Оформление SIM-карты",
"deal_ttl": "5000",
"pin_title": "Сообщите пин-код сотруднику и ожидайте дальнейших действий",
"footer": "Может потребоваться документ, удостоверяющий личность",
"steps": [
{
"permission_step_create_dto": {
"sysname": "PERS_DATA_EXT",
"expire": "1576800",
"responsible_object": "Иванов Иван Иванович",
"purposes": {
"elements": {
"sysname": [
"PERS_DATA_EXT"
]
}
},
"actions": {
"elements": {
"sysname": [
"SHARE_DATA"
]
}
},
"scopes": {
"elements": {
"sysname": [
"mobile_ext"
]
}
}
}
},
{
"final_step_create_dto": {
"title": "Оформление успешно завершено",
"content": "Ожидайте дальнейших действий от сотрудника",
"footer": "Бесплатная горячая линия - 8 800 700 0611"
}
}
]
}
}
}
Сценарий 10
Запрос
{
"env": "EPGU",
"deal_types": {
"get_deal_type_request": {
"page": "1",
"size": "10"
}
}
}
Ответ
{
"deal_types": {
"deal_type_lite_response": [
{
"id": "97206458-cfd7-4117-ba5c-6429982ffcf4",
"name": "Оформление SIM-карты"
},
{
"id": "97206458-cfd7-4117-ba5c-6429982ffc55",
"name": "Оформление SIM-карты"
}
]
}
}
Сценарий 11
Запрос
{
"env": "EPGU",
"qr_codes": {
"create_qr_request": {
"department_id": "296f2580-62cd-41bb-aa64-5fe0e5716bd7",
"qr_ttl": "2",
"deal_type": [
"6f867b43-ab74-4247-a533-177a39cb55f8"
],
"qr_type": "static"
}
}
}
Ответ
{
"qr_codes": {
"qr_response": [
{
"guid": "15108574-d50e-4d71-80aa-e0786e827164",
"base64_image": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADIAQAAAACFI5MzAAABwUlEQVR4Xu2WW2rEMAxFBd6WQVs3aFuG9B6FJmFo/6T2JyLziM+AXlea2PGb2efBZS95CfaXZJmNI5b5njYi8raDhK6IrdMtOLjtIYu7NT32OPQ9b5sI15zjII5Osv3YY00zjz4ClHe9O5k+KlpKkETc9qGdOoJtUjyW4/u0erJsLJsqKS+zOfXZQTC1zXz5SqFYD5HXsZxcz87dCikmLq+ORpSrRvnOtJrIqWQonWiwlPMjgkqSLePDJitQAX1HUEzkXFtiU07JXUlfii8lykvpUUtGTOsidV9PxHSYEiHbZ0VLyVbH0J+WudLU6VXRYuKqqQIYJI0Or4oWE+1vVJ9jFSz1K9NSkrmm4olGv+NLA4lUBT9AhpL/VdFiogxzdNVApsv4l+ogWkjIPNh80n6qpIHgf6L4cc4WomwhlFHzRNt0/tiwtSSQB1FI6pse7lshpeT885PbFKMCuWtdSzwvHrdS74AGgtEslVLi4DmlhyycqpiONIJdQb71JLgoaSD27+euBrJQuZNtDrBl/5rIeS41asAobxvZ7HOtJfXvI4IyklBPXNKho0dOGkgq5Mi2ke+6I6glP9tLXoL9P/kCai1Vu+XxTkwAAAAASUVORK5CYII=",
"link": "https://l11.epgu-front.test.gosuslugi.ru/gos-qr/15108574-d50e-4d71-80aa-e0786e827164",
"deal_type": [
{
"deal_type_id": "89b12df2-4010-4317-a5ea-0adbe26c1666",
"name": "Оформление SIM-карты",
"pin_title": "Сообщите пин-код сотруднику и ожидайте дальнейших действий",
"footer": "Может потребоваться документ, удостоверяющий личность"
}
]
}
]
}
}
Сценарий 12
Запрос
{
"env": "EPGU",
"qr_codes": {
"get_qr_request": {
"department_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"page": "1",
"size": "10"
}
}
}
Ответ
{
"qr_codes": {
"qr_response": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"base64_image": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
"link": "https://www.gosuslugi.ru/gos-qr/3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deal_type": [
{
"deal_type_id": "008e0725-e020-41cf-bb13-87938e32d239",
"name": "Оформление SIM-карты",
"pin_title": "Сообщите пин-код сотруднику и ожидайте дальнейших действий",
"footer": "Может потребоваться документ, удостоверяющий личность"
},
{
"deal_type_id": "008e0725-e020-41cf-bb13-87938e32d559",
"name": "Оформление SIM-карты",
"pin_title": "Сообщите пин-код сотруднику и ожидайте дальнейших действий",
"footer": "Может потребоваться документ, удостоверяющий личность"
},
{
"deal_type_id": "008e0725-e020-41cf-bb13-87938e32d779",
"name": "Оформление SIM-карты",
"pin_title": "Сообщите пин-код сотруднику и ожидайте дальнейших действий",
"footer": "Может потребоваться документ, удостоверяющий личность"
}
],
"transaction_id": "5ef0381d-0cb3-42b5-bf4b-960352d5d9db"
},
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66a555",
"base64_image": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
"link": "https://www.gosuslugi.ru/gos-qr/3fa85f64-5717-4562-b3fc-2c963f66a555",
"deal_type": [
{
"deal_type_id": "0840af96-60ec-4d2b-8e68-ed100256b099",
"name": "Оформление SIM-карты",
"pin_title": "Сообщите пин-код сотруднику и ожидайте дальнейших действий",
"footer": "Может потребоваться документ, удостоверяющий личность"
}
]
}
]
}
}
Сценарий 13
Запрос
{
"env": "EPGU",
"deals": {
"upload_file_deal_request": {
"transaction_id": "e9080ade-c05f-4928-b9b1-3618a00d2796",
"file_name": "Example.sig",
"mime_type": "application/x-pkcs7-signature"
}
}
}
Ответ
{
"deals": {
"upload_file_deal_response": {
"file_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
}
Сценарий 14
Запрос
{
"env": "EPGU",
"deals": {
"add_steps_deal_request": {
"transaction_id": "e9080ade-c05f-4928-b9b1-3618a00d2796",
"steps": [
{
"interrupt_step_create_dto": {
"title": "Оформление прервано",
"content": "Уточните информацию у сотрудника",
"footer": "Бесплатная горячая линия - 8 800 700 0611"
}
}
]
}
}
}
Ответ
{
"deals": {
"deal_response": {
"status": "cancelled",
"steps": [
{
"status": "interrupted",
"data": {
"interrupt_step_response": {
"title": "Оформление прервано",
"content": "Уточните информацию у сотрудника",
"footer": "Бесплатная горячая линия - 8 800 700 0611"
}
}
},
{
"status": "new",
"data": {
"permission_step_response": {
"sysname": "PERS_DATA_EXT",
"expire": "1576800",
"responsible_object": "Иванов Иван Иванович",
"purposes": {
"elements": {
"sysname": [
"PERS_DATA_EXT"
]
}
},
"actions": {
"elements": {
"sysname": [
"SHARE_DATA"
]
}
},
"scopes": {
"elements": {
"sysname": [
"mobile_ext"
]
}
},
"iss_perm_id": "456578",
"oid": "107000455"
}
}
}
],
"deal_type": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expires": "259199998",
"index": "0"
}
}
}
Сценарий 15
Запрос
{
"env": "EPGU",
"deals": {
"download_file_deal_request": {
"transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"file_id": "e9080ade-c05f-4928-b9b1-3618a00d2796"
}
}
}
Ответ
{
"deals": {
"fault_response": {
"fault_code": "500",
"fault_message": "Внутренняя ошибка"
}
}
}
Сценарий 16
Запрос
{
"env": "EPGU",
"deals": {
"get_deal_request": {
"transaction_id": "e9080ade-c05f-4928-b9b1-3618a00d2796"
}
}
}
Ответ
{
"deals": {
"deal_response": {
"status": "agile",
"steps": [
{
"status": "completed",
"data": {
"permission_step_response": {
"sysname": "PERS_DATA_EXT",
"expire": "1576800",
"responsible_object": "Иванов Иван Иванович",
"purposes": {
"elements": {
"sysname": [
"PERS_DATA_EXT"
]
}
},
"actions": {
"elements": {
"sysname": [
"SHARE_DATA"
]
}
},
"scopes": {
"elements": {
"sysname": [
"mobile_ext"
]
}
},
"iss_perm_id": "456879",
"oid": "107000455"
}
}
}
],
"deal_type": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expires": "259199998",
"index": "0"
}
}
}
Сценарий 17
Запрос
{
"env": "EPGU",
"deals": {
"get_agile_deal_request": {
"guid": "00ed429b-7db5-433f-9774-67a0bf68ad13",
"pin": "1478"
}
}
}
Ответ
{
"deals": {
"get_agile_deal_response": {
"transaction_id": "c5bb377b-dd24-4075-8f55-8880e3ea8649"
}
}
}
Сценарий 18
Запрос
{
"env": "EPGU",
"deals": {
"get_pins_deal_request": {
"guid": "00ed429b-7db5-433f-9774-67a0bf68ad13",
"page": "1",
"size": "2"
}
}
}
Ответ
{
"deals": {
"get_pins_deal_response": [
{
"pin": "1478",
"created": "1697468270"
},
{
"pin": "1998",
"created": "1697468587"
}
]
}
}