API fromu (ФРОМУ)

API для проверки клиентов по перечням ФРОМУ.

Сервис предоставляет методы для массовой и индивидуальной проверки клиентов по перечням организаций и физических лиц, связанных с терроризмом или распространением оружия массового уничтожения, составляемым в соответствии с решениями совета безопасности ООН.

Результаты проверок всех клиентов

Method	URI	Description
GET|HEAD	/api/maintenance/fromu/report/make	Создать отчет fromu
GET|HEAD	/api/fromu/all-clients/result/files	Получить список файлов результатов ФРОМУ
GET|HEAD	/api/fromu/all-clients/result/file/{filename}	Скачать файл результата ФРОМУ
GET|HEAD	/api/fromu/all-clients/result/list	Получить список результатов ФРОМУ
GET|HEAD	/api/fromu/all-clients/result/qty	Получить количество результатов ФРОМУ

Индивидуальные проверки клиентов

Method	URI	Description
GET|HEAD	/api/fromu/client/{client_id}/check	Получить информацию о проверке клиента в ФРОМУ
POST	/api/fromu/client/{client_id}/check	Запустить новую проверку клиента в ФРОМУ
GET|HEAD	/api/fromu/client/{client_id}/status	Показать текущий статус клиента по его ID в ФРОМУ
GET|HEAD	/api/fromu/record/{fromuId}	Получить запись ФРОМУ

Описание Методов API

Результаты проверок всех клиентов

Создать отчет fromu

GET|HEAD /api/maintenance/fromu/report/make

Описание

Методы предназначены для создания в системе RFM отчета на основе данных проверок по спискам ФРОМУ. Метод используется для формирования аналитических отчетов по результатам проверок, мониторинга эффективности работы системы и подготовки данных для внешних систем.

Примеры запросов

GET /api/maintenance/fromu/report/make

Пример успешного ответа

{
    "status": "ok",                      // Статус выполнения операции ("ok" при успешном выполнении)
    "timestamp": 1755006198000,          // Временная метка ответа в миллисекундах
    "data": null                         // Данные ответа (null, так как методы только запускают процесс создания отчета)
}

---

Получить список файлов результатов ФРОМУ

GET|HEAD /api/fromu/all-clients/result/files

Описание

Метод возвращает список всех доступных файлов с результатами проверок ФРОМУ. Файлы содержат результаты массовых проверок клиентов в системе ФРОМУ.

Пример запроса

GET /api/fromu/all-clients/result/files

Пример успешного ответа

{
    "status": "ok",                                    // Статус ответа
    "timestamp": 1754139352000,                        // Временная метка ответа
    "data": [                                          // Массив имен файлов результатов
        "2023-10-13_131543.xlsx",                      // Файл от 13.10.2023 13:15:43
        "2023-10-17_125710.xlsx",                      // Файл от 17.10.2023 12:57:10
        "2023-10-18_113003.xlsx",                      // Файл от 18.10.2023 11:30:03
        "2023-10-18_113027.xlsx",                      // Файл от 18.10.2023 11:30:27
        "2023-10-18_113509.xlsx",                      // Файл от 18.10.2023 11:35:09
        "2023-10-19_093038.xlsx",                      // Файл от 19.10.2023 09:30:38
        "2023-10-20_065838.xlsx",                      // Файл от 20.10.2023 06:58:38
        "2023-10-20_124748.xlsx",                      // Файл от 20.10.2023 12:47:48
        "2023-10-20_124853.xlsx",                      // Файл от 20.10.2023 12:48:53
        "2023-10-20_132313.xlsx",                      // Файл от 20.10.2023 13:23:13
        "2023-10-20_173216.xlsx",                      // Файл от 20.10.2023 17:32:16
        "2023-11-29_103455.xlsx",                      // Файл от 29.11.2023 10:34:55
        "2023-11-29_103704.xlsx",                      // Файл от 29.11.2023 10:37:04
        "2023-11-29_103827.xlsx",                      // Файл от 29.11.2023 10:38:27
        "2025-05-05_132331.xlsx"                       // Файл от 05.05.2025 13:23:31
    ]
}

---

Скачать файл результата ФРОМУ

GET|HEAD /api/fromu/all-clients/result/file/{filename}

Описание

Метод позволяет скачать конкретный файл с результатами проверок ФРОМУ по его имени. Файл содержит детальную информацию о результатах массовой проверки клиентов. Имя файла должно точно соответствовать списку из метода GET /api/fromu/all-clients/result/files

Параметры запроса

{filename} (string, обязательный) — имя файла для скачивания (например: "2023-10-13_131543.xlsx").

Пример запроса

GET /api/fromu/all-clients/result/file/2023-10-13_131543.xlsx

Пример успешного ответа

\\\\\

---

Получить список результатов ФРОМУ

GET|HEAD /api/fromu/all-clients/result/list

Описание

Метод возвращает список всех результатов проверок клиентов в системе ФРОМУ. Каждая запись содержит историю проверок клиента, его текущий статус и идентификаторы.

Пример запроса

GET /api/fromu/all-clients/result/list

Пример успешного ответа

{
    "status": "ok",                                    // Статус ответа
    "timestamp": 1754139770000,                        // Временная метка ответа
    "data": [                                          // Массив результатов проверок
        {
            "checkLog": [                               // История проверок клиента
                {
                    "found": true,                      // Результат проверки - найден
                    "date": "2025-02-25T14:57:27+00:00" // Дата и время проверки
                },
                {
                    "found": true,                      // Результат проверки - найден
                    "date": "2025-02-25T15:09:17+00:00" // Дата и время проверки
                },
                {
                    "found": true,                      // Результат проверки - найден
                    "date": "2025-03-24T11:26:09+00:00" // Дата и время проверки
                },
                {
                    "found": true,                      // Результат проверки - найден
                    "date": "2025-07-14T07:47:02+00:00" // Дата и время проверки
                }
            ],
            "clientId": 1163,                           // ID клиента
            "currentStatus": 1,                          // Текущий статус клиента (1 - найден, 0 - не найден)
            "num": 6908488,                             // Номер записи
            "fromu_id": 6908488                         // ID записи в системе ФРОМУ
        }
    ]
}

Анализ истории проверок клиента ID 1163:

1. 25.02.2025: Клиент найден в системе ФРОМУ
2. 24.03.2025: Клиент остается в системе ФРОМУ
3. 23.04.2025: Клиент остается в системе ФРОМУ
4. 05.05.2025: Клиент остается в системе ФРОМУ
5. 07.05.2025: Клиент остается в системе ФРОМУ
6. 23.05.2025: Клиент остается в системе ФРОМУ
7. 28.05.2025: Клиент остается в системе ФРОМУ
8. 04.06.2025: Клиент остается в системе ФРОМУ
9. 14.07.2025: Клиент остается в системе ФРОМУ

Текущий статус: Клиент находится в системе ФРОМУ (currentStatus: 1)

Примечания

• Метод возвращает полную историю проверок всех клиентов
• Каждая запись содержит детальную информацию о проверках клиента
• currentStatus отражает актуальный статус на момент последней проверки
• fromu_id соответствует идентификатору в системе ФРОМУ

---

Получить количество результатов ФРОМУ

GET|HEAD /api/fromu/all-clients/result/qty

Описание

Метод возвращает общее количество клиентов, найденных в системе ФРОМУ. Показывает статистику по результатам проверок всех клиентов.

Пример запроса

GET /api/fromu/all-clients/result/qty

Пример успешного ответа

{
    "status": "ok",                                    // Статус ответа
    "timestamp": 1754140070000,                        // Временная метка ответа
    "data": {
        "count": 1                                     // Количество клиентов, найденных в системе ФРОМУ
    }
}

---

Индивидуальные проверки клиентов

Получить информацию о проверке клиента в ФРОМУ

GET|HEAD /api/fromu/client/{client_id}/check

Описание

Метод возвращает текущую информацию о проверке клиента в системе ФРОМУ. Показывает актуальный статус клиента на момент последней проверки.

Параметры запроса

{client_id} (integer, обязательный) — уникальный идентификатор клиента.

Пример запроса

GET /api/fromu/client/1163/check

Пример успешного ответа

{
    "status": "ok",                                    // Статус ответа
    "timestamp": 1754140267000,                        // Временная метка ответа
    "data": {
        "found": "found",                              // Результат проверки - клиент найден в системе ФРОМУ
        "status": "FOUND"                              // Статус клиента - найден в системе ФРОМУ
    }
}

---

Запустить новую проверку клиента в ФРОМУ

POST /api/fromu/client/{client_id}/check

Описание

Метод запускает новую проверку клиента в системе ФРОМУ и возвращает актуальный результат. В отличие от GET-метода, этот метод принудительно обновляет статус клиента.

Параметры запроса

{client_id} (integer, обязательный) — уникальный идентификатор клиента.

Пример запроса

POST /api/fromu/client/1162/check

Пример успешного ответа

{
    "status": "ok",                                    // Статус ответа
    "timestamp": 1754140468000,                        // Временная метка ответа
    "data": {
        "found": "not found",                          // Результат проверки - клиент не найден в системе ФРОМУ
        "status": "NOT_FOUND"                          // Статус клиента - не найден в системе ФРОМУ
    }
}

---

Показать текущий статус клиента по его ID

GET|HEAD /api/fromu/client/{client_id}/status

Описание

Метод возвращает детальную информацию о статусе клиента в системе ФРОМУ, включая полную историю проверок. Показывает текущий статус клиента и все предыдущие проверки с датами.

Параметры запроса

{client_id} (integer, обязательный) — уникальный идентификатор клиента.

Пример запроса

GET /api/fromu/client/1162/status

Пример успешного ответа

{
    "status": "ok",                                    // Статус ответа
    "timestamp": 1754150985000,                        // Временная метка ответа
    "data": {
        "clientId": "1162",                            // ID клиента
        "checkLog": [                                   // История проверок клиента
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-02-25T14:57:27+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-02-25T15:09:18+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-02-25T17:50:14+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-04-23T08:39:46+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-04-23T08:47:09+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-05-05T13:22:07+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-05-05T14:40:13+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-05-07T10:03:02+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-05-23T06:46:50+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-05-28T13:36:17+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-06-04T15:12:54+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-07-14T07:47:03+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-08-02T13:14:28+00:00"    // Дата и время проверки
            },
            {
                "found": false,                         // Результат проверки - не найден
                "date": "2025-08-02T15:57:15+00:00"    // Дата и время проверки
            }
        ],
        "currentStatus": false,                         // Текущий статус клиента (false - не найден, true - найден)
        "fromu_id": 0,                                 // ID записи в системе ФРОМУ (0 если не найден)
        "lastCheck": "2025-08-02T15:57:15+00:00"      // Дата и время последней проверки
    }
}

Анализ истории проверок клиента ID 1162:

1. 25.02.2025: Клиент не найден в системе ФРОМУ
2. 23.04.2025: Клиент не найден в системе ФРОМУ
3. 05.05.2025: Клиент не найден в системе ФРОМУ
4. 07.05.2025: Клиент не найден в системе ФРОМУ
5. 23.05.2025: Клиент не найден в системе ФРОМУ
6. 28.05.2025: Клиент не найден в системе ФРОМУ
7. 04.06.2025: Клиент не найден в системе ФРОМУ
8. 14.07.2025: Клиент не найден в системе ФРОМУ
9. 02.08.2025: Клиент не найден в системе ФРОМУ

Текущий статус: Клиент не находится в системе ФРОМУ (currentStatus: false)