Сервіс RiskTools NBU-Proxy¶

Сервіс RiskTools NBU-Proxy (далі Proxy) забезпечує інтеграцію з сервісами НБУ, зокрема Кредитним Реєстром 2.0

Принцип взаємодії з НБУ: кожен пакет підписується ЕЦП компанії у форматі ECDSA та відправляється в API реєстру. На підставі накладеного підпису НБУ ідентифікує компанію, яка відправляє звіт.

На даний момент цей API працює в режимі proxy:

Приймає від вас дані
Підписує їх ключем ECDSA
Відправляє в НБУ на url, переданий у запиті
Повертає відповідь, отриману від сервісу НБУ зі статусами та заголовками.

Швидкий старт¶

Приклад запиту:

POST https://crypto.risktools.pro/nbureg/proxy

Заголовки запиту:

AuthKey: ваш ключ доступу до API
Content-Type: application/json

Тіло запиту:

{
  "body": {
    // Дані для відправки в НБУ
  },
  "url": "https://cr-nbfi-test.bank.gov.ua/package-submission/api/financial-companies/v1/submit-package",
  "key": "ключ ecdsa в base64",  // Необов'язкове поле
  "password": "пароль_до_ключа"  // Необов'язкове поле
}

Пояснення полів запиту:¶

body: Обов'язкове поле. Містить дані, які потрібно відправити в НБУ.
url: Обов'язкове поле. Вказує endpoint НБУ, на який будуть відправлені дані.
key: Необов'язкове поле. Бінарний ключ ЕЦП (ECDSSA), закодований в форматі Base64.
password: Необов'язкове поле. Вказує пароль до ключа ЕЦП, якщо він потрібен.

Примітка: Поля key та password є необов'язковими, якщо ключ зберігається на сервері RiskTools. У такому випадку сервіс автоматично використовує збережений ключ для підпису даних.

Приклад відповіді:

{
  "status": "ok", # результат на рівні Proxy
  "result": {
    "status_code": 201, # статус відповіді НБУ
    "status_text": "Created", # статус відповіді НБУ
    "headers": { # Заголовки відповіді НБУ
    },
    "is_success": true, # статус відповіді НБУ
    "body": { # Тіло відповіді НБУ
      "package_id": "45bc2193bf725e039c21a8f73db518b6c8047eca232e5d40bef2995cecd6b9ec",
      "client_id": "...", # ваш ЄДРПОУ
      "kvi_date": "2024-07-03T14:16:36.049"
    }
  },
  "exec_time_ms": 1077.507, # час обробки на рівні Proxy
  "request_id": "8212f133-be80-4bae-b765-6402ba282aa2" # id запиту Proxy
}

Додаткова інформація¶

Якщо у вас виникли питання, пропозиції або потреба в додатковій допомозі, будь ласка, пишіть нам на електронну адресу:

info@risktools.pro

Ми завжди раді допомогти вам і відповісти на ваші запитання.