Ссылка скопирована
Издөө

Процесс работы с открытыми токенами клиник

Содержание

Что такое API

API (Application Programming Interface) — это набор правил, протоколов и инструментов, который позволяет разным программам и сервисам взаимодействовать друг с другом.

Простыми словами, API — это согласованный «язык общения» между разными информационными системами, который необходим, чтобы различные сервисы могли друг друга понимать и эффективно обмениваться информацией.

Что такое API-токен и зачем он нужен

API-токен — это уникальный ключ, который используется при обмене запросами по API для аутентификации и авторизации инициатора запроса.

Стандартный API-токен выглядит следующим образом: cdda9acf1bc5fdd8b148539a5f7a752fabeeecebdd121fe1a946c1e065af04be

Для чего используется:

  • Идентификация пользователя или приложения – API-токен подтверждает, что запрос поступает от знакомого системе, допустимого, доверенного источника
  • Контроль доступа – определяет, какие данные или функции API доступны пользователю с указанным токеном
  • Безопасность – заменяет логин и пароль, снижая риск утечки учетных данных
  • Мониторинг и ограничение запросов – сервер может отслеживать активность по токену и ограничивать число запросов

Что такое открытый API-токен, выпускаемый клиникой в МедФлекс (открытый токен, токен клиники)

МедФлекс предоставляет возможность клинике безопасно интегрироваться с различными сервисами, даже если их нет в Магазине интеграций в личном кабинете МедФлекс. Также, ряд партнёров, доступных для интеграции, по умолчанию используют функционал открытого токена. Процесс выпуска токена клиникой описан в Help.

Важно! По открытому токену передается информация сразу по всем филиалам клиники, передавать информацию только по одному из них нельзя.

Если вы хотите передавать информацию только по одному филиалу из нескольких, вам необходимо отключить интеграцию на остальных филиалах.

Схема взаимодействия:

  1. Клиника самостоятельно заключает прямой договор с каким-либо сервисом, в котором МедФлекс не является третьей стороной и участником договора
  2. Вместо разработки (или в случае невозможности) прямой интеграции клиника и партнёр договорились об использовании API МедФлекс для обмена данными
  3. Клиника выпускает открытый токен в личном кабинете МедФлекс и передаёт его сервису-партнёру
  4. Партнер интегрируется с МедФлекс по API, указывая в запросах переданный токен клиники (раздел для партнёров в Help)
  5. Клиника пополняет баланс в МедФлекс, если планируется использование платных методов API (в случае недостатка средств платные методы будут недоступны)
  6. Партнёр завершает интеграцию и на регулярной основе делает запросы к API МедФлекс с указанием токена клиники
  7. МедФлекс отслеживает запросы сервиса по платным методам API. В соответствии со стандартным лицензионным договором с баланса клиники списываются денежные средства

Какие проблемы решает открытый токен клиники в МедФлекс

  1. Клинике и сервису не нужно разрабатывать, тестировать и поддерживать прямую интеграцию – всё уже есть в МедФлекс, даже если партнёр не представлен в Магазине интеграций
  2. В некоторых случая открытый токен клиники в МедФлекс – это единственный способ интегрироваться с МИС клиники
  3. Клинике можно не беспокоиться о безопасности передаваемых данных сервису-партнёру – каждый партнёр при интеграции проходит этап технического ревью командой разработки МедФлекс

Какие группы методов API доступны партнёру по открытому токену

Если партнёру необходим доступ по открытому токену к определённому методу API не из данного списка, такой запрос можно рассмотреть в индивидуальном порядке.

Сколько стоит использование открытого токена

Важно! стоимость и условия использования указаны в стандартном лицензионном договоре.

Клиника оплачивает использование только 2 методов API сервисом-партнёром (деньги списываются с баланса МедФлекс). Остальные доступные по открытому токену методы API можно использовать бесплатно. Платные методы:

Метод POST ​​/direct_appointment​/doctor​/execute​/

  • Для чего: создание онлайн-записи в МИС клиники по API
  • Стоимость: зависит от кол-ва запросов

Метод GET /models​/doctor​/ с параметром запроса «detailed: true»

  • Для чего: получение расширенной информации о врачах
  • Стоимость: зависит от кол-ва врачей, по которым запрашивается информация. В случае, если партнёру не нужна расширенная информация о врачах, он указывает в запросе «detailed: false» и клиника ничего за такой запрос не платит

Список параметров, доступных при запросе расширенной информации о врачах (с параметром запроса «detailed: true»):

  • avatar (фото врача с ПроДокторов)
  • education_and_experience (информация о стаже и учёной степени)
  • rating (рейтинг врача на ПроДокторов)
  • reviews (этот массив всегда будет пустой - нужен для обратной совместимости с некоторыми интеграциями)