Как работать с API в МИС SQNS?

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

Перед подключением убедитесь, что в системе выполнены следующие настройки:

• включен функционал онлайн-записи;

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

Шаг 1. Перейдите в левом меню в раздел «Настройки» (1) - Управление правами доступа (2).

Шаг 2. Нажмите кнопку «+ Новый набор прав доступа».

Шаг 3. Создайте набор прав без доступа к каким-либо разделам и сохраните данные.

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

Шаг 4. Перейдите в левом меню: «Сотрудники» (1) - Сотрудники (2).

Шаг 5. Нажмите кнопку «+ Новый сотрудник».

Шаг 7. Перейдите во вкладку «Управление доступом».

Шаг 8. Установите отметку в чек-боксе напротив значения «Разрешить доступ к системе».

Шаг 9. Введите уникальный адрес электронной почты (он не должен использоваться ранее в системе). На эту почту придет письмо для подтверждения доступа.

Шаг 10. Выберите набор прав, созданный ранее и сохраните изменения.

Шаг 11. Подтвердите почту по ссылке из письма.

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

Для получения ключа отправьте запрос в техническую поддержку МИС SQNS. В запросе укажите номер аккаунта и адрес электронной почты сотрудника, на которую нужно выдать ключ.

Способы обращения:

• на электронную почту: support@sqns.ru;
• через чат непосредственно в системе.

Сотрудник поддержки направит вам ответное письмо, когда ключ будет сгенерирован и добавлен в ваш аккаунт.

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

Шаг 1. Откройте документацию API (Swagger):
Для получения токена используется веб-интерфейс на основе документации — Swagger, где описаны все доступные методы API.

• Дента: https://crm3.sqns.ru/docs/swagger/
• Клиника: https://crm2.sqns.ru/docs/swagger/

Шаг 2. Найдите метод «Auth» и нажмите кнопку «Try it out».

Шаг 3. Поля ввода станут активными. Укажите логин и пароль:
логин - адрес электронной почты, на которую был выдан ключ;
пароль - пароль от личного кабинета МИС SQNS.

Шаг 4. Нажмите кнопку «Execute».

После успешного выполнения запроса вы увидите ответ от сервера. В поле token этого ответа будет указан ваш авторизационный токен. Используйте его во всех последующих запросах к API.

Чтобы программа понимала, что именно вы хотите сделать, используются стандартные HTTP-методы. В зависимости от запроса они разделены по цветам.

Список методов:

• Дента: https://crm3.sqns.ru/docs/swagger/
• Клиника: https://crm2.sqns.ru/docs/swagger/

1.Выгрузка данных из системы (используется метод «GET», выделен голубым цветом):
Позволяет вытянуть данные из системы, сохранить их в файл и передать на другую платформу (ПроДокторов, СберЗдоровье, Битрикс 24, сайт вашей клиники и т.д.) или использовать для формирования отчетов.

Что можно выгрузить:

• визиты (лимит: 100 визитов за один запрос);
• пациентов;
• сотрудников;
• услуги (должны быть указаны продолжительность и сотрудник, оказывающий услугу);
• товары;
• способы оплаты.

2.Загрузка данных в систему
(используется метод «POST», выделен зеленым цветом):
Позволяет «разместить» в МИС новые данные, которых там ранее не было. Также позволяет передавать в систему данные из внешних источников. Например, при записи пациента через «СберЗдоровье» или «ПроДокторов» эти сервисы автоматически создают в МИС карточки пациентов и визиты.

Что можно загрузить:

• визиты;
• пациентов.

• Особенность: если пациент с таким номером телефона уже есть в базе, визит автоматически привяжется к уже существующей карточке.

3.Редактирование и удаление (используется методы «POSTPUT», «PATCH», «DELETE»):
Позволяют изменить или удалить данные, которые уже есть в системе. Для работы с ними обязательно нужно знать ID сущности, которую хотите изменить.

Что можно редактировать/удалять:

• визиты (нельзя удалять прошедшие визиты и визиты в статусе «Клиент пришел»);
• статус визита;
• данные пациентов.