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

Ниже приведены два типовых сценария: синхронный (ожидание результата в одном запросе) и асинхронный (запрос + отдельное получение результата).

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

Используйте эту страницу, когда нужно быстро выбрать режим интеграции с API NEWDB и понять, как получать результат по requestId.

Типовые кейсы

• Подготовка первой интеграции с API NEWDB
• Выбор между синхронным ожиданием результата и асинхронной обработкой
• Проверка формата запросов, токена и структуры ответа API

Синхронный метод (run)

Синхронный режим ставит задачу в очередь и удерживает соединение до получения результата или таймаута. Максимальное время ожидания — 3600 секунд. Если requestId не передан, он будет создан автоматически. Если requestId уже существует, API вернёт ранее сохранённый результат.

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

GET https://api.newdb.net/v2/run?method=passport_mvd&seria=4115&number=350298&firstname=Александр&lastname=Сидоров&country=ru&token=<your_token>&requestId=<uuid4>

Успешный ответ (пример)

{
  "requestId": "b4c61a6b-34cc-430e-bbeb-a6518014bca4",
  "state": "complete",
  "results": {
    "passport_mvd": {
      "result": {
        "status": 200,
        "data": [
          {
            "doc_status": "Данные не найдены"
          }
        ]
      }
    }
  }
}

Ответ по таймауту

{
  "requestId": "b4c61a6b-34cc-430e-bbeb-a6518014bca4",
  "state": "timeout",
  "error": "Task execution timeout"
}

Асинхронный метод

Асинхронный режим состоит из двух шагов: отправка запроса и последующее получение результата по requestId.

Шаг 1. Отправка запроса

Отправьте POST на https://api.newdb.net/v2 и передайте токен в заголовке X-API-KEY.

{
  "params": {
    "seria": "4115",
    "number": "350298",
    "method": "passport_mvd",
    "firstname": "Александр",
    "lastname": "Сидоров",
    "country": "ru"
  },
  "requestId": "b4c61a6b-34cc-430e-bbeb-a6518014bca4"
}

Шаг 2. Получение результата

POST https://api.newdb.net/v2

* Отправить повторно POST запрос с тем же requestId

Или получить результат через отдельный GET-метод по requestId:

GET https://api.newdb.net/v2/data?requestId=b4c61a6b-34cc-430e-bbeb-a6518014bca4&token=<your_token>

Где: - requestId — идентификатор ранее отправленного запроса - token — API-токен

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

{
  "params": {
    "seria": "4115",
    "number": "350298",
    "method": "passport_mvd",
    "firstname": "Александр",
    "lastname": "Сидоров",
    "country": "ru",
    "newdb_qid": "EL4VILiX9MW7MygB"
  },
  "requestId": "b4c61a6b-34cc-430e-bbeb-a6518014bca4",
  "datecreated": "2026-01-13 22:02:33",
  "state": "complete",
  "balance": 9884,
  "tasks": 1,
  "is_repeat": false,
  "results": {
    "passport_mvd": {
      "taskId": "f7bb40dd-703c-40c6-8c9b-2a0d4306f90b",
      "dateupdated": "2026-01-13 22:03:19",
      "result": {
        "status": 200,
        "data": [
          {
            "doc_status": "Данные не найдены"
          }
        ]
      }
    }
  }
}

AI Summary

Компактные метаданные для AI и агентных систем

{
  "method": "run | async",
  "intent": "Быстрый старт по синхронному и асинхронному вызову API NEWDB",
  "endpoint": "POST https://api.newdb.net/v2",
  "required_headers": ["X-API-KEY"],
  "required_fields": ["method", "country"],
  "returns": ["state", "results.<method>.result.status", "results.<method>.result.data"]
}