Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/diev/portal5-works
Works with API of Portal5. Работа с Portal5 по API.
https://github.com/diev/portal5-works
Last synced: about 2 months ago
JSON representation
Works with API of Portal5. Работа с Portal5 по API.
- Host: GitHub
- URL: https://github.com/diev/portal5-works
- Owner: diev
- License: apache-2.0
- Created: 2024-03-21T04:32:34.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T19:48:09.000Z (2 months ago)
- Last Synced: 2024-10-24T06:44:54.279Z (2 months ago)
- Language: C#
- Homepage:
- Size: 525 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Portal5-Works
[](https://ci.appveyor.com/project/diev/portal5-works)
[](https://github.com/diev/Portal5-Works/actions/workflows/dotnet8-desktop.yml)
[](https://github.com/diev/Portal5-Works/releases/latest)
Works with API of Portal5.
Работа с Portal5 по API.
## Settings / Параметры
*Appsettings* с именем исполняемой программы - в отличие от принятого при
разработке в .NET единого имени, так можно все файлы настроек разных
программ размещать в одной папке для скриптов, но при этом какие-то общие
параметры (будут иметь приоритет) вынести из папки с программой, где они
могут быть нечаянно затерты при обновлении версии или конфиденциальная
информация может попасть в дистрибутивный архив:
- `CryptoBot.config.json` (located with App `exe`)
- `%ProgramData%\Diev\CryptoBot.config.json` (these settings overwrite if exist)
Однако, при запуске в Linux программа может не получать путь к папке
с программой - тогда она будет искать традиционный `appsettings.json`
в текущей папке.
*Windows Credential Manager* в Панели управления - *Диспетчер учетных данных*
(все пароли для всех программ меняются в одном месте и скрыты от
пользователей, как было бы при хранении в индивидуальных файлах настроек
к каждой программе):
- `Portal5test *` (name: `Portal5test https://{host}`, user: `{username}`, pass: `{password}`)
- `Portal5 *` (name: `Portal5 https://{host}`, user: `{username}`, pass: `{password}`)
- `CryptoPro My` (name: `CryptoPro My`, user: `{cert}`, pass: `{pin}`)
- `SMTP *` (name: `SMTP {host} {port} tls`, user: `{sender}`, pass: `{password}`)
Однако в Linux такой программы нет, и все параметры надо написать в JSON
открытым текстом (в Windows тоже так можно, игнорируя безопасность):
- `"TargetName": "https://{host} {username} {password}"` (три параметра)
- `"CryptoName": "cert {cert} {pin}"` (три параметра, первый игнорируется)
- `"SmtpName": "{host} {port} tls {sender} {password}"` (4-5 параметров)
При наличии (в Windows) КриптоПро можно указать, какая утилита
командной строки будет использоваться (важно для больших файлов):
- `"UtilName": "CspTest"` - бесплатная утилита из состава КриптоПро CSP
- `"UtilName": "CryptCP"` - утилита для больших файлов (приобрается отдельно)
## CLI - параметры командной строки:
Используйте `--help`, чтобы получить все параметры командной строки:
```txt
Description:
Exchange point to upload/download with Portal5.
Usage:
CryptoBot [command] [options]
Options:
--version Show version information
-?, -h, --help Show help and usage information
Commands:
clean Очистить лишнее из отчетности старее 30 дней
load Загрузить одно сообщение или все по фильтру
z130 Получение информации об уровне риска ЮЛ/ИП
z137 Ежедневное информирование Банка России о составе и объеме клиентской базы
```
По команде `load --help`, где надо указать или id, или условия фильтра:
```txt
Description:
Загрузить одно сообщение или все по фильтру
Usage:
CryptoBot load [] [options]
Arguments:
Идентификатор одного сообщения (guid или url/guid)
Options:
-z, --zadacha Номер задачи XX ('Zadacha_XX')
-d, --today Текущий день только
-f, --min-date С какой даты (yyyy-mm-dd)
-t, --max-date По какую дату (yyyy-mm-dd)
--min-size От какого размера (байты)
--max-size До какого размера (байты)
--inbox Входящие сообщения только
--outbox Исходящие сообщения только
--status Статус сообщений
для inbox: new, read, replied
для outbox: draft, sent, delivered, error,
processing, registered, rejected, success
--page Номер страницы по 100 сообщений
-?, -h, --help Show help and usage information
```
## API usage examples / Примеры использования API
Документация на REST-API по Portal5 (ЕПВВ) находится по адресу
.
В программе реализованы по документу "30.09.2023 Описание внешнего
взаимодействия. Технические условия внешнего обмена. Версия 2.4"
все актуальные разделы 3.1.3-3.1.6.
Программа получает с портала всю справочную информацию и решает следующие
конкретные задачи (названия приведены по справочнику задач `tasks`):
- `Zadacha_2-1` - Ответ на запрос, предписание. Запрос в Банк России. Квитанции из ВП ЕПВВ
- `Zadacha_3-1` - Запрос, предписание. Ответ на запрос НФО. Квитанции из САДД
- `Zadacha_54` - Запросы ЦИК
- `Zadacha_130` - Получение информации об уровне риска ЮЛ/ИП
- `Zadacha_137` - Ежедневное информирование Банка России о составе и объеме клиентской базы (ФПС "Отчетность")
- Очистка сообщений отчетности ПП Дельта в `inbox`:
- `Zadacha_97` - Извещение о результатах контроля информации о ВПОДК и их результатах (ИЭС1)
- `Zadacha_107` - Извещение о результатах контроля отчетности субъектов НПС (ИЭС1)
- `Zadacha_114` - Извещение о результатах контроля представления формы 0409310 (ИЭС1)
- `Zadacha_123` - Извещение о результатах контроля представления формы 0409310 (ИЭС2)
- `Zadacha_130` - Получение информации об уровне риска ЮЛ/ИП
- `Zadacha_133` - Извещение о результатах контроля отчетности субъектов НПС (ИЭС2)
- `Zadacha_140` - Извещение о результатах контроля информации о ВПОДК и их результатах (ИЭС2)
- `Zadacha_156` - Извещение о результатах контроля представления формы 0409601 отчет ко(нко) (ИЭС1) и др.
- `Zadacha_159` - Извещение о результатах контроля представления формы 0409601 отчет ко(нко) (ИЭС2) и др.
- Очистка сообщений отчетности ПП Дельта в `outbox`:
- `Zadacha_155` - Представление отчетности КО в Банк России
Легко добавить и остальные по потребности.
К каждой задаче в API может применяться фильтр дат
(в программе некоторые зафиксированы на 14 или 30 дней - по смыслу).
По завершении каждой операции подписчикам отправляются уведомления по
e-mail.
### ЗСК (Светофор)
Получение реестра (`Zadacha_130`):
CryptoBot z130
Отправка перечня клиентов (`Zadacha_137`):
CryptoBot z137
При необходимости отправить файл не текущей даты, можно указать число дней
для просмотра назад в поисках последнего: `1` - вчера, `7` - за неделю.
### Скачивание конкретного сообщения или по фильтру
Скачивание конкретного сообщения (указать его `Id` или URL
с окончанием на `Id`):
CryptoBot load d55cdbbb-e41f-4a2a-8967-78e2a6e15701
Скачивание Входящих писем из ЛК (`Zadacha_3-1`) по фильтру дат (за сегодня):
CryptoBot load -z 3-1 -d
Скачивание Входящих писем из ЛК (`Zadacha_3-1`) по фильтру дат (за вчера):
CryptoBot load -z 3-1 -d 1
Скачивание Исходящих писем из ЛК (`Zadacha_2-1`) по фильтру дат (за 2023):
CryptoBot load -z 2-1 -f 2023-01-01 -t 2023-12-31
Скачивание запросов ЦИК (`Zadacha_54`) по фильтру дат (с начала июля):
CryptoBot load -z 54 -f 2024-07-01
При необходимости даты можно уточнить временем по полному формату
`yyyy-mm-ddThh:mm:ssZ`. Контроль ошибок указания такой строки не ведется,
но сервер вернет ошибку 400 - "Некорректное значение параметра запроса"
в таком случае.
Будьте осторожны с указанием фильтра: сервер ограничивает выдачу - не
более 100 сообщений за раз, но программа попытается скачать все, попадающее
в условия фильтра, без ограничений. Для получения сообщений страницами по
100 - используйте параметр фильтра `--page N`.
Если стоит CryptoPro CSP, то все скачанные пакеты можно расшифровать для
помещения на хранение. Если в скачиваемом периоде менялись ключи, то можно
указать предыдущие. После скачивания можно очистить место в ЛК.
### Очистка места в ЛК
Очистка ЛК от служебной информации ПП Дельта.
В коде зафиксировано оставить последние 30 дней (на самом деле и они не
нужны - все есть в самой ПП Дельта). Недокументированный код 0 для этой
задачи назначен условно - для целей единообразного запуска программы:
CryptoBot clean
## Requirements / Требования
- .NET 8 Desktop Runtime
- CryptoPro CSP (опционально - для криптоопераций)
## Build / Построение
Build an app with many dlls.
В папке дистрибутива будет `exe` и очень много сопутствующих отдельных
`dll` - вариант разработки в .NET по умолчанию:
dotnet publish CryptoBot\CryptoBot.csproj -o Distr
Build a single-file app when NET Desktop runtime required.
Будет один исполняемый файл `exe`, но требуется установка .NET -
предпочитаемый мною вариант:
dotnet publish CryptoBot\CryptoBot.csproj -o Distr -r win-x64 -p:PublishSingleFile=true --no-self-contained
Build a single-file app when no runtime required.
Вариант, когда .NET устанавливать не нужно - всё есть в одном большом файле,
который можно перенести в закрытую систему, где ничего устанавливать нельзя:
dotnet publish CryptoBot\CryptoBot.csproj -o Distr -r win-x64 -p:PublishSingleFile=true
Build an app on Windows and transfer binary files to Linux.
Вариант, когда папку с файлами, собранную на Windows, можно просто перенести
на Linux и там запустить, ничего там не устанавливая:
dotnet publish CryptoBot\CryptoBot.csproj -o Distr -r linux-x64 --self-contained
Для использования одного/нескольких из этих вариантов можно применять
`build.cmd` - он создаст нужный дистрибутив(ы) с архивом исходных файлов
текущей версии.
## Versioning / Порядок версий
Номер версии программы указывается по нарастающему принципу:
* Требуемая версия .NET (8);
* Год текущей разработки (2024);
* Месяц без первого нуля и день редакции (624 - 24.06.2024);
* Номер билда - просто нарастающее число для внутренних отличий.
Если настроен сервис AppVeyor, то это его автоинкремент.
Продукт развивается для собственных нужд, а не по коробочной
стратегии, и поэтому *Breaking Changes* могут случаться чаще,
чем это принято в *SemVer*.
## License / Лицензия
Licensed under the [Apache License, Version 2.0](LICENSE).
Вы можете использовать эти материалы под свою ответственность.
[](https://t.me/dievdo)