Подтверждение записи
На этой странице представлена информация по использованию API системы сбора отчетов. Отчеты собираются для передачи данных о записи пациентов в медицинские учреждения.
Регистрация и получение токена
-
Создайте приложение, при этом заполните поля:
-
название — можно указать произвольно;
-
иконка сервиса — необязательно;
-
платформы приложения — выберите веб-сервисы;
-
redirect URI — укажите
https://oauth.yandex.ru/verification_code; -
доступ к данным — укажите
doctors-clinics:write_reports.
-
-
Нажмите Создать приложение и скопируйте его ClientID (напротив идентификатора нажмите значок
). -
Добавьте скопированный ClientID в ссылку вида
https://oauth.yandex.ru/authorize?response_type=token&client_id=<идентификатор приложения> -
Перейдите по ссылке и на открывшейся странице скопируйте ваш авторизационный токен.
Токен действует 6 месяцев. Чтобы получить новый токен, перейдите по ссылке из п. 3 еще раз.
Примечание
Токен передается при передаче отчетов вместе с остальными параметрами в теле запроса. См. Формат сообщений.
Механика взаимодействия
При переходе со страницы Яндекс на сайт партнера к URL-адресу страницы добавляется GET-параметр &ya_token.
Передайте значение этого параметра в запросе на метод подтверждения записи. Cм. Формат сообщений.
Формат сообщений
-
Запросы направляются в виде POST по адресу: https://yandex.ru/medicine-api/orders.
-
Параметры передаются в теле запроса в таком формате:
application/x-www-form-urlencoded. -
Обязательные параметры для успешной записи, уточняющие параметры для фактически осуществленной записи.
| Имя | Тип | Описание |
|---|---|---|
access_token |
string |
Токен аутентификации партнера, полученный при регистрации приложения. |
ya_token |
string |
Токен, переданный при переходе на сайт партнера. |
price |
integer |
Стоимость услуги.* |
clinic_id |
string |
Идентификатор клиники, соответствует атрибуту "внутренний идентификатор клиники" в фиде партнера.* |
doctor_id |
string |
Идентификатор врача, соответствует атрибуту "внутренний идентификатор врача" в фиде партнера.* |
slot_time |
number |
Время, на которую произведена запись, в формате "Unix Timestamp" (Unix Epoch).* |
specialization |
string |
Специализация врача, соответствует атрибуту "id" списка специализации в фиде партнера.* |
service |
string |
Услуга.* |
* Значения параметров должны соответствовать финальному выбору пользователя на момент подтверждения записи, включая любые изменения, внесенные на странице подтверждения заявки.
Формат ответа метода POST /medicine-api/orders
При успешном ответе тело ответа будет пустое. В случае ответа с ошибкой уточнение возвращается в виде текста (plaintext).
| Код | Причина | Описание |
|---|---|---|
| 204 | NO_CONTENT | Успешный ответ. Тело ответа пустое. |
| 400 | BAD_REQUEST | Общая ошибка. В ответе может содержаться уточнение. |
| 401 | UNAUTHORIZED | Ошибка аутентификации партнера. Скорее всего, ошибка связана с неверно переданным или устаревшим токеном аутентификации. |
| 405 | METHOD_NOT_ALLOWED | Ошибка метода в обращении. Сервер принимает запросы POST. |
| 429 | TOO_MANY_REQUESTS | Слишком много одновременных запросов со стороны всех партнеров. При нормальной нагрузке такая ситуация возникать не должна. |
| 500 | INTERNAL_SERVER_ERROR | Неуточненная ошибка со стороны сервера. В ответе может содержаться уточнение. |