История запросов и журнал проверок

NEWDB предоставляет программный интерфейс для получения списка всех ранее созданных проверок (заявок), их статусов и параметров через эндпоинт GET /v2/requests (или алиас GET /v2/history), а также через drop-in совместимый эндпоинт GET /flcheck/data/list для интеграций по схеме «ЗаЧестныйБизнес».

---

Когда использовать

• Построение пользовательского интерфейса истории проверок в вашей CRM / ERP или внутреннем кабинете.
• Проверка текущих статусов фоновых задач (например, переход из processing в complete).
• Аудит отправленных запросов, поиск requestId по дате или методу.
• Drop-in миграция с внешних провайдеров (например, ЗаЧестныйБизнес), использующих метод списка проверок физлиц.

---

Точки входа (URL)

Контур / Формат	Метод	URL	Описание
Продуктовый контур (NewDB)	GET	https://api.newdb.net/v2/requests	Основной боевой эндпоинт с пагинацией и данными из request_log
Продуктовый контур (Алиас)	GET	https://api.newdb.net/v2/history	Полный функциональный синоним /v2/requests
Совместимость с ЗБ	GET	https://api.newdb.net/flcheck/data/list	Эндпоинт в формате «ЗаЧестныйБизнес»
Тестовый контур (Sandbox)	GET	https://api.newdb.net/test/v2/requests	Изолированная песочница без авторизации и списаний

---

Авторизация

Запрос требует обязательной авторизации (в тестовом контуре используется синтетический токен по умолчанию). Поддерживаются следующие способы передачи ключа:

1. HTTP-заголовок X-API-KEY: <your_token> (рекомендуется).
2. HTTP-заголовок Authorization: Bearer <your_token>.
3. Параметр в строке запроса: ?token=<your_token> или ?api_key=<your_token>.

---

Параметры запроса (Query String)

Параметр	Тип	По умолчанию	Описание
page	integer	1	Номер страницы (начиная с 1).
limit	integer	20	Количество записей на странице (от 1 до 100).
format	string	—	При значении zb (или ЗБ) ответ форматируется по контракту «ЗаЧестныйБизнес».

---

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

1. Боевой запрос в формате NewDB

curl -X GET 'https://api.newdb.net/v2/requests?page=1&limit=20' \
  -H 'X-API-KEY: <your_token>'

Пример ответа:

{
  "total": 1420,
  "page": 1,
  "limit": 20,
  "data": [
    {
      "requestId": "40ee40ad-8011-4987-9ec7-0103df269c06",
      "method": "fssp_person",
      "state": "complete",
      "datecreated": "2026-09-15 09:05:16",
      "params": {
        "lastname": "Иванов",
        "firstname": "Иван",
        "secondname": "Иванович",
        "dob": "1985-05-15",
        "regioncode": "100"
      }
    },
    {
      "requestId": "8f12a34b-56cd-78ef-90ab-1234567890cd",
      "method": "complex_by_passport",
      "state": "complete",
      "datecreated": "2026-09-15 08:42:10",
      "params": {
        "seria": "4510",
        "number": "123456",
        "lastname": "Петров",
        "firstname": "Сергей",
        "dob": "1990-11-20"
      }
    }
  ]
}

Поля ответа NewDB:

• total — общее количество запросов пользователя за всё время.
• page — текущий номер страницы.
• limit — лимит элементов на странице.
• data — массив объектов запросов:
  • requestId — уникальный UUID заявки.
  • method — идентификатор метода проверки (fssp_person, complex_by_passport, egrul и др.).
  • state — статус обработки: complete (завершен), processing (в работе), queued (в очереди), error (ошибка).
  • datecreated — дата и время создания запроса в формате YYYY-MM-DD HH:MM:SS.
  • params — входные параметры, переданные при создании проверки.

---

2. Запрос в формате «ЗаЧестныйБизнес» (ZB)

Вы можете вызвать специальный маршрут /flcheck/data/list или добавить параметр format=zb:

curl -X GET 'https://api.newdb.net/flcheck/data/list?api_key=<your_token>&page=1&limit=20'

Пример ответа:

{
  "status": "200",
  "message": "Запрос выполнен успешно",
  "total": 1420,
  "currentPage": 1,
  "data": [
    {
      "id": "40ee40ad-8011-4987-9ec7-0103df269c06",
      "status": "Готово",
      "ФИО": "Иванов Иван Иванович",
      "birthdate": "1985-05-15",
      "inn": "771234567890",
      "паспорт": "4510 123456",
      "ВУ": null,
      "create_at": "2026-09-15 09:05:16"
    }
  ]
}

---

3. Вызов в тестовом контуре (Sandbox)

Для отладки без боевого токена и реальных обращений к базе:

curl -X GET 'https://api.newdb.net/test/v2/requests'

---

Получение полного результата проверки

По полученному из списка requestId (или id) вы можете в любой момент запросить полный JSON-результат проверки:

1. В формате NEWDB:

   curl -X GET 'https://api.newdb.net/v2/data?requestId=40ee40ad-8011-4987-9ec7-0103df269c06' \
     -H 'X-API-KEY: <your_token>'
   

2. В формате «ЗаЧестныйБизнес» (отчет по заявке):

   curl -X GET 'https://api.newdb.net/flcheck/data/report?id=40ee40ad-8011-4987-9ec7-0103df269c06&api_key=<your_token>'