Интеграция с другими сервисами (API + токен)

Содержание:

• Что такое API
• Что такое API-токен и зачем он нужен
• Что такое открытый API-токен, выпускаемый клиникой в МедФлекс (открытый токен, токен клиники)
• Какие проблемы решает открытый токен клиники в МедФлекс
• Какие группы методов API доступны партнёру по открытому токену
• Сколько стоит использование открытого токена
• Как создать токен

Для интеграции с сервисами, которых нет в магазине интеграций МедФлекса, в личном кабинете вы можете создать свой ключ доступа (токен). Ключ нужно будет передать техническим специалистам сервиса, с которым вы хотите интегрироваться.

Что такое API

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

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

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

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

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

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

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

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

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

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

Пример взаимодействия:

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

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

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

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

Спецификация публичного API МедФлекса доступна по ссылке - https://developer.medflex.ru/clinic-token/

• Модели
• Расписание
• Онлайн-запись
• Услуги
• Настройка веб-хуков (только уведомления по услугам, без приёмов)

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

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

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

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

• Для чего: создание онлайн-записи в МИС клиники
• Оплата: за успешно созданные записи

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

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

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

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

Как создать токен

1. Войдите в магазин интеграций.

2. В самом низу в блоке «Дополнительные сервисы (оплачиваются клиникой)» нажмите «Добавить сервис».

3. Введите название сервиса.

4. Нажмите «Сгенерировать код доступа».

5. Сгенерированный код и есть токен. Скопируйте его и отправьте специалистам сервиса, с которым хотите интегрироваться.

6. После закрытия окна сервис появится в списке интеграций. Интеграция заработает, когда сервис реализует её на своей стороне.

Важно! Ключ доступа является конфиденциальной информацией. Передавайте его только доверенному лицу, чтобы ключ не попал в открытый доступ.

Если нужно будет временно ограничить доступ сервиса к вашей МИС, достаточно изменить положение переключателя в карточке (должен стать серым).

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