Инструкция для подключения API через ИИ
Эта страница нужна для ChatGPT, Claude, Cursor, Codex и внутренних ИИ-ассистентов. Передайте ИИ ссылку на /llms.txt и OpenAPI-схему — он получит контекст подключения без лишней ручной расшифровки.
Скопировать в ИИ
Готовый промпт для кодогенератора
Вставьте этот текст в ИИ-инструмент вместе с задачей: “реализуй клиент”, “подключи API к CRM”, “сделай опрос статуса” или “создай серверный метод”.
Подключи RealIQ API v1 к моей серверной части.
Базовый адрес: https://api.realiq.ru/api/v1
Схема OpenAPI: https://api.realiq.ru/api/v1/openapi.json
Авторизация: передавай API-ключ в заголовке X-API-KEY.
Ключ хранить только на сервере, не в браузере.
Основной сценарий:
1. Сначала вызови POST /checks/quote и покажи цену.
2. Потом вызови POST /checks с типом проверки: продавец, объект или комплексная проверка.
3. Сохрани check_id.
4. Опросом GET /checks/{check_id} жди, пока status не станет report_ready, partial или failed.
5. Для report_ready/partial покажи result, risk_score, pdf_url/report_url и доказательный блок.
6. Обрабатывай ошибки validation_error, insufficient_funds, scope_denied, rate_limit_exceeded, idempotency_conflict.
7. Для POST /checks используй Idempotency-Key.
8. Не считай partial полной ошибкой: это готовый результат с ограничениями источников.
9. Не называй source_unavailable и source_not_connected отсутствием риска.
10. Для проверки цифрового следа используй GET /verify/{sha256}.
Сначала реализуй тестовый режим с ключом riq_test, потом вынеси базовый адрес и ключ API в переменные окружения.Какой поток должен собрать ИИ
Шаг 1
Предрасчёт
POST /checks/quote показывает цену и хватает ли баланса.
Шаг 2
Запуск
POST /checks создаёт асинхронную проверку и возвращает check_id.
Шаг 3
Опрос
GET /checks/{check_id} возвращает статус и финальный результат.
Шаг 4
Цифровой след
В готовом ответе сохраняются PDF, SHA, метка времени и хеши источников.
Чек-лист для проверки результата
- Взять OpenAPI как источник схем, а не переписывать поля вручную.
- Сделать серверный API-клиент: клиентский код не должен видеть X-API-KEY.
- Добавить предрасчёт → запуск проверки → опрос статуса → результат.
- Сохранять check_id, request_id, pdf_url, risk_score и корневой хеш доказательного блока.
- Обработать partial как отдельное состояние результата.
- Показывать пользователю понятные статусы вместо технических ошибок источников.