Обзор

В этом руководстве вы найдёте базовую информацию о принципах работы API МедФлекс и о подготовке к его использованию.

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

МедФлекс - это сервис интеграции, предназначенный для защищенного обмена данными между участниками рынка коммерческой медицины в сфере здравоохранения (далее МедФлекс).

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

С подробным техническим описанием функционала API МедФлекс и примерами его работы можно ознакомиться по ссылке

Методы и объекты

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

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

Авторизация пользователя

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

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

В общем случае для идентификации в API используется специальный ключ доступа, который называется access_token. Ключ доступа — это строка из цифр и латинских букв, которую вы передаёте на сервер вместе с запросом. Из этой строки сервер получает всю нужную ему информацию.

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

Подробнее о получении токена можно прочитать в разделе Аутентификация

С чего начать

Вы познакомились с основными понятиями, связанными с API МедФлекс. Дальше всё зависит лишь от ваших целей и задач.

Для работы с API можно использовать самые разные языки программирования.

Далее рекомендуем ознакомиться с описанием методов

За подробной технической информацие для разработчиков можно обратиться к нашему swagger-у