×
Меню
Индекс
  • 9. API

9. API

ПОРЯДОК ВЗАИМОДЕЙСТВИЯ С СЕРВИСОМ
Взаимодействие с Сервисом осуществляется по API протоколу HTTPS согласно схеме «запрос – ответ» по адресам в соответствии с типом запроса при условии обязательной авторизации.
Запрос к Сервису выполняется методом POST, необходимые данные передаются в параметрах POST-запроса. Передаваемые данные должны иметь кодировку UTF-8.
Ответ Сервиса представляет собой JSON структуру определенного формата, которая вкладывается в тело HTTP-ответа. Данные ответа имеют кодировку UTF-8.
 
ТИПЫ ЗАПРОСОВ
В настоящей версии Сервиса насчитывается следующие типы запросов:
1.     Создание заявки на запись на приём.
 
АВТОРИЗАЦИИ
Авторизация происходит при передаче параметров login и password в параметрах POST запроса. Узнать или создать эти данные можно в программе «2V: Стоматология» в разделе «Настройки» > «Настройки программы» > Вкладка API.
 
Рис 1. Login и password для авторизации через API
 
1. ОПИСНИЕ ЗАПРОСА ДЛЯ СОЗДАНИЯ ЗАПИСИ НА ПРИЁМ
 
Параметр
Имя
Обязательный
Тип
Замечание
Логин
login
+
string
 
Пароль
password
+
string
 
ФИО пациента
name
+
string
 
Телефон
phone
+
numeric
9999999999
Дата
date
+
date
dd.mm.yyyy
Время
time
-
time
00:00
Email
mail
-
string
 
Комментарий
comment
-
string
 
Метка источника
utm_source
-
string
 
 
Пример успешного ответа
{"status":"success","id":"2478"}
При успешном статусе ответа, так же возвращается id заявки на запись.
 
Пример ошибки
{"status":"error","desc":"Не указана дата записи"}
При статусе ошибки, так же возвращается поле desc, которое содержит описание ошибки.
 
Код utm_source для каждого отдельного источника можно задать в программе «2V: Стоматология». После чего можно передавать utm_source каждого источника.
 
Рис 2. Установка кода utm_source