Содержание:
- Общая схема подключения клиники
- Какие данные по клинике недоступны без отправки уведомления о платеже
- Аутентификация
- Методы API
Для получения доступа к данным необходимо передать в МедФлекс информацию о принятых от клиники платежах. На основе этих данных МедФлекс открывает доступ к данным клиники по API на оплаченный период.
Важно! Доступ к данным клиники через API предоставляется только после передачи информации о платеже.
Тестовый бесплатный период не предусмотрен. Для получения доступа к данным клиники на время пилота передайте информацию о платеже на минимальную сумму (от 1 000 ₽).
Какие данные по клинике недоступны без отправки уведомления о платеже 
- Получение списка приёмов - GET /appointments/appointments/
- Получение приёма по UUID - GET /appointments/appointments/{uuid}/
- Обновление статуса приёма - PATCH /appointments/appointments/{uuid}/
- Получение вебхуков о создании и изменении приёмов в МИС GET /appointments/webhooks/
Общая схема подключения клиники
Выполните следующие шаги при подключении новой клиники:
- Дождитесь, пока клиника включит интеграцию с вашим сервисом в Личном кабинете МедФлекса.
- Получите заявку от клиники, заключите договор и примите оплату.
- Запросите информацию о клинике с помощью метода GET /appointments/lpus/all/
- Передайте информацию о платеже в МедФлекс через API биллинга (метод POST /billing/payments/).
- Проверьте, что платеж за указанный период прошел и данные по клинике доступны с помощью метода GET /appointments/lpus/.
- После получения платежа МедФлекс откроет доступ к API клиники на указанный период (date_start – date_end).
- После истечения оплаченного периода доступ закроется автоматически. Для продления передайте информацию о новом платеже.
Аутентификация
Для работы с API биллинга используйте ваш индивидуальный партнёрский токен — тот же, что вы применяете для основного API Триггерных рассылок. Получать новый токен не требуется.
Методы API
Получение информации о клиниках
Воспользуйтесь методом GET /appointments/lpus/all/ для получения списка всех клиник которые могут быть интегрированы с вашим сервисом.
Метод GET /appointments/lpus/ возвращает информацию о клиниках находящихся в статусе success.
Статусы доступности филиалов
- disabled - клиники у которых отключена интеграция по триггерным рассылкам в личном кабинете МедФлекс.
- need_payment - клиники у которых включена интеграция в личном кабинете МедФлекс и ожидается информация о платеже.
- need_mis_settings - МедФлекс получил информацию о платеже, но для работы требуется настройка в МИС клиники.
- success - интеграция корректно работает.
Передача информации о платеже
Для передачи информации о платеже используйте метод POST /billing/payments/ каждый раз при получении оплаты от клиники. API МедФлекс начнёт передавать данные клиники в ваш сервис только после успешного вызова метода.
Важно! Валюту на текущем этапе не передавайте. Система подразумевает рубли (RUB).
Получение списка переданных платежей
Используйте метод GET /billing/payments/ для сверки данных или формирования отчётов. Он возвращает постраничный список всех платежей, которые ваш сервис ранее передал в МедФлекс.
Продление доступа к данным клиники
Для продления доступа к данным клиники после истечения оплаченного периода передайте информацию о новом платеже через метод `POST /billing/payments/` с актуальными значениями `date_start` и `date_end`.
Важно! Предусмотрите в вашей логике заблаговременное продление.
После наступления даты `date_end` доступ к данным клиники по API автоматически закроется и передача данных остановится до получения информации о новом платеже.
По вопросам токенов, доступов и платежей обратитесь к вашему персональному менеджеру МедФлекс.