#Онбординг партнёра
Подключение выполняется совместно с командой Smartica. Оно включает регистрацию адаптера, обмен секретами, настройку API МИС и приёмочный тест. Одной выдачи platform недостаточно.
Для старта напишите на support@smartica.ai или через форму связи.
#Этап 1. Заявка
В первом сообщении укажите:
- название МИС и клиники;
- контакт технического специалиста;
- предполагаемые тестовый и рабочий хосты МИС;
- доступность API из интернета, через VPN или allowlist;
- желаемые сроки тестирования.
Smartica подтверждает, что адаптер может быть подключён, и назначает технический контакт.
#Этап 2. Фиксация контракта
Команды согласуют:
| Тема | Что нужно зафиксировать |
|---|---|
| Идентификатор | Формат и область уникальности encounter_id |
| SSO | Точный endpoint, platform, обязательные поля запроса |
| GET | Финальный URL, пример ответа, timeout |
| PUT | Финальный URL, метод PUT, правила обновления полей и стенограммы |
| Авторизация | Схема, отдельные секреты для окружений, ротация |
| Сеть | DNS, TLS, VPN или IP allowlist |
| Данные | Куда МИС сохраняет стенограмму и многострочные значения |
| Ошибки | Безопасное тело ответа и контакт для инцидентов |
Для запросов Smartica → МИС поддерживаются HTTP Basic и Bearer. Если нужны mTLS, подпись запроса или другая схема — сообщите об этом до реализации.
Учётные данные вашего API и SSO_KEY передаются через согласованный защищённый канал при онбординге. Храните секреты только на сервере МИС.
#Этап 3. Что передаёт команда МИС
- Базовые URL тестового и рабочего окружений.
- Финальный путь
GETиPUTс placeholder{id}. - Учётные данные тестового API через согласованный защищённый канал.
- Тестовый
encounter_id, доступный из API. - Email и ФИО тестового врача.
- Реальный пример ответа GET.
- Ожидаемое место сохранения PUT.
- Контакт разработчика для разбора ошибок.
Не отправляйте пароли, API-ключи и персональные данные обычным письмом, если защищённый канал не был согласован.
#Этап 4. Что выдаёт Smartica
После регистрации и настройки адаптера Smartica передаёт:
| Параметр | Описание |
|---|---|
platform |
Зарегистрированный slug вашей МИС |
| SSO endpoint | Точный URL; шаблон с {platform} нельзя использовать до активации |
SSO_KEY |
Bearer-секрет для запросов бэкенда МИС к SSO API |
| URL окружения | Адрес тестового или рабочего приложения Smartica |
| Сетевые параметры | Источники запросов или требования подключения, если используются |
Используйте отдельные секреты для тестового и рабочего окружений.
#Этап 5. Подготовка тестовых данных
Для контрольного прогона создайте:
- уникальный приём в поддерживаемом формате
encounter_id; - врача с валидными
user_emailиuser_full_name; - непустой
template; - минимум два поля с уникальными
idи понятнымиlabel; - место, где можно увидеть входящий
PUTбез ручного поиска по логам.
Аккаунт врача заранее создавать в Smartica не обязательно. При первом SSO-входе Smartica создаст его в настроенной организации, если переданы email и ФИО. Если email уже относится к другой организации Smartica, SSO вернёт 403.
#Этап 6. Приёмочный прогон
Интеграция готова к включению, когда подтверждены все пункты:
- SSO вызывается с бэкенда и возвращает рабочий
launch_url - Новый врач входит без отдельной регистрации
- Существующий врач входит в тот же аккаунт
-
GETвозвращает ожидаемый приём, шаблон и поля - После записи МИС получает
PUTс полями и полной стенограммой - Повторный одинаковый
PUTне создаёт дубликат - Повторная запись в том же приёме обновляет существующие данные
-
401,403,404,422,429и временный5xxотображаются понятно - Успешные ответы содержат JSON;
204 No Contentне используется - Секреты и
launch_urlотсутствуют в клиентском коде и логах
#Правила изменений после запуска
- Не меняйте путь, auth, формат ID,
fields[].idили смыслtemplateбез согласования. - Добавление новых полей допустимо, если их
idуникальны, аlabelоднозначны. - Ломающие изменения сначала проверяются на тестовом окружении.
- Аудиофайл не входит в текущий контракт. Если он нужен, согласуйте отдельное расширение.