Справочник по проверке недвижимости
Как формировать документы к сделке через API
Асинхронный API генератора RealIQ: данные сделки, preflight, резерв стоимости, generation_id и защищённая выдача DOCX/PDF.
- 01Создать тестовый ключ с правом document-generator и проверить структуру запроса и ответа без файлов и списаний.
- 02Сопоставить поля CRM с draft.scenario, сторонами, объектами, ценой, платежами и особыми условиями.
- 03Для каждого live-запроса формировать стабильный уникальный Idempotency-Key.
Короткий ответ
Как подключить генератор документов RealIQ к CRM?
CRM передаёт в POST /api/v1/document-generator структурированный draft со сценарием, сторонами, объектом и условиями сделки. RealIQ проверяет данные, после успешного preflight резервирует рассчитанную стоимость и формирует комплект штатным юридическим конвейером. Интеграция опрашивает generation_id и скачивает готовые DOCX/PDF только с тем же API-ключом.
Что важно понимать
- Один API использует тот же юридический каталог, проверки качества и worker, что и генератор в кабинете.
- До успешного preflight деньги не резервируются; блокирующие пропуски возвращаются как action_required.
- Idempotency-Key защищает проект и финансовое действие от сетевого дубля.
- Каждый готовый файл имеет SHA-256 и закрыт API-ключом создавшей интеграции.
Чек-лист перед решением
- Создать тестовый ключ с правом document-generator и проверить структуру запроса и ответа без файлов и списаний.
- Сопоставить поля CRM с draft.scenario, сторонами, объектами, ценой, платежами и особыми условиями.
- Для каждого live-запроса формировать стабильный уникальный Idempotency-Key.
- Обрабатывать processing, completed, action_required и failed; GET статуса можно повторять без списаний.
- Скачивать DOCX/PDF сервером, сохранять SHA-256 и не передавать API-ключ в браузер.
Типовые ошибки
- Считать sandbox готовым юридическим документом: он проверяет контракт интеграции, но не создаёт реальные файлы.
- Повторять исправленный запрос с прежним Idempotency-Key и другим телом.
- Пытаться скачать защищённый файл публичной ссылкой без X-API-KEY.
- Игнорировать action_required и автоматически подписывать incomplete_draft.
FAQ
Частые вопросы
Когда списывается стоимость комплекта?
Только после успешного preflight: worker создаёт серверный расчёт и штатный резерв. При техническом срыве или недостаточном качестве резерв освобождается.
Можно ли передать персональные данные во внешнюю модель?
Внешний preflight разрешается только после псевдонимизации и проверки защищённого хранилища ключей. Можно установить allow_external_llm=false для локального режима.
Как получить полный список сценариев и полей?
Используйте OpenAPI по адресу https://api.realiq.ru/api/v1/openapi.json и страницу метода /developers/document-generator.