Ссылка скопирована
Мы используем cookie и Яндекс.Метрику, чтобы сайт работал лучше
Поиск

API записи на услуги

Оглавление

Как устроена интеграция

Основной путь — поиск услуги через унифицированный справочник платформы МедРокет: вы находите услугу по общему классификатору, получаете конкретные филиалы и внутренние идентификаторы услуги и врача, а затем используете их в расписании и записи.

Идентификаторы уникальны только внутри своего типа сущности. Одинаковое числовое значение id в унифицированном справочнике и id услуги в конкретном филиале — разные сущности.

Методы API

Справочники

  • Получить список городов GET /models/town/ — города, отфильтрованные по вашей стране. Точка входа в интеграцию: отсюда вы берёте town_id для поиска услуг.
  • Получить список регионов GET /models/region/.
  • Получить список доступных филиалов GET /models/lpu/ — с фильтрами по городу, специальности, наличию цен и другим признакам.
  • Получить список доступных групп филиалов GET /models/lpu_group/.
  • Получить список районов города GET /models/district/, список метро GET /models/metro/ и список линий метро GET /models/metro_line/ — для гео-фильтров при поиске филиалов.
  • Получить список специальностей GET /models/speciality/.
  • Получить список врачей с расписанием GET /models/doctor/ — справочник врачей унифицированной модели.

Поиск услуг

  • Получить список услуг GET /uni/services/ — услуги унифицированного справочника с категориями. Ответ кэшируется на 24 часа; наличие услуги в справочнике не гарантирует, что по ней прямо сейчас есть свободные слоты.
  • Получить список филиалов, оказывающих услугу GET /uni/services/{uni_service_id}/lpus/ — филиалы в городе, где есть эта услуга и свободные слоты. В ответе вы получаете уже конкретные orig_service_id для следующего шага.

Расписание

  • Получить расписание услуг POST /schedule/services/ — свободные слоты по конкретным услугам и филиалам на ближайшие 30 дней.

Оригинальный справочник из МИС

МИС — медицинская информационная система клиники.

  • Получить список врачей GET /orig/doctors/ — врачи филиалов из МИС, с сопоставлением идентификатору в унифицированном справочнике.

Запись, отмена и история

Бизнес-кейсы

Важно: в справочниках нет услуг, требующих предварительной консультации врача - создание онлайн-записей на такие услуги недоступно

Кейс 1. Нет понимания, в каком именно филиале искать нужную услугу

Это основной сценарий: вы ведёте пациента по общему каталогу услуг, а не по прайс-листу конкретной клиники.

  1. Методом Получить список городов запросите town_id нужного города .
  2. Методом Получить список услуг запросите нужную услугу в унифицированном справочнике (рекомендуем кэшировать эти данные на своей стороне и обновлять раз в сутки)
  3. В запросе по методу Получить список филиалов, оказывающих услугу укажите полученные ранее uni_service_id и town_id для запроса филиалов, где услуга доступна для записи. В ответе вы получите lpu_id и orig_service_id.
  4. Методом Получить расписание услуг уточните свободные слоты и, если нужно, конкретного врача .
  5. Методом Создать онлайн-запись на услугу создайте запись, передав выбранные lpu_id, orig_service_id, время и данные пациента.

Кейс 2. Филиал и услуга уже известны

Если lpu_id и orig_service_id у вас уже есть — например, сохранились с прошлого обращения, — шаги 1–3 из первого сценария можно пропустить и сразу перейти к расписанию и записи:

  • Методом Получить расписание услуг уточните свободные слоты и, если нужно, конкретного врача .
  • Методом Создать онлайн-запись на услугу создайте запись, передав выбранные lpu_id, orig_service_id, время и данные пациента.

Кейс 3. Нужно отменить запись

  1. Если uuid записи сохранён, то вы можете сразу сделать запрос по методу Отменить онлайн-запись на услугу.
  2. Если uuid записи нет — найдите запись методом Получить историю онлайн-записей, отфильтровав по телефону пациента и (или) диапазону дат.

Частые вопросы

Как получить токен для доступа к API?
Токен для разработки и тестирования интеграции по вашему запросу пришлёт менеджер по работе с партнёрами МедРокет. Для разработки и тестирования по данному токену будет доступ только к данным тестовой клиники. По окончании разработки ваш основной токен для ОЗ будет переключен и с ним можно будет создавать и записи к врачу и на услугу.

Обязательно ли указывать врача при записи?
Нет. Если врача не указать, его назначит клиника самостоятельно.

Можно ли получить справочник услуг один раз и не запрашивать его при каждом обращении пациента?
Да, рекомендуем кэшировать на 24 часа. При этом, доступность конкретных слотов необходимо проверять отдельно: наличие услуги в справочнике не означает, что есть свободные слоты для записи.

Что означает ограничение в 30 дней в расписании услуг?
Один запрос расписания не может охватывать период дальше 30 дней от текущей даты.

Запрос на создание записи завис без ответа — можно ли повторить его безопасно?
Прежде чем повторять запрос, проверьте историю записей по телефону пациента: если запись уже создалась, повторная отправка может привести к ошибке или к лишней записи.

Тарифицируется ли каждый запрос к API?
Нет, тарифицируется только каждый успешный запрос на создание записи — согласно условиям вашего договора.

Нужного города нет в справочнике городов — что делать?
Справочник отфильтрован по вашей стране. Если города не хватает, обратитесь к менеджеру по работе с партнёрами МедРокет.