Project

General

Profile

Документация API

Авторизация в yaVapteke REST API

YaVapteke API поддерживает авторизацию на основе JWT токенов.
Для обращения к любому из ресурсов yaVapteke API требуется наличие JWT токена в заголовке Authorization HTTP запроса, с типом Bearer. При отсутствии токена API вернет 401 статус (Unauthorized), этот же статус вернется в случае, если время действия токена закончилось (токен выдается на определенное время). В обоих случаях нужно запросить новый токен.

Схема работы API


Порядок выполнения авторизации на сервисах API
1. Получаем токен на сервере авторизации
2. Полученный токен (берется из поля access_token ответа авторизации) используется для запросов к API.
3. При получении от API статуса 401 (Unauthorized), т.е. по истечении срока годности токена, токен запрашивается повторно

Процессы работы с заказами

С определенной периодичностью опрашивается API для получения информации о новых или измененных заказах. Все полученные с сайта yaVapteke.ru заказы будут приняты и обработаны.

Схема движения заказа со статусами
  • Новый заказ
    При получении нового заказа, если присутствуют строки с товаром из наличия, пытается бронировать все товары по этим строкам.
    Если заказ со строками только из наличия, возможны следующие варианты:
    1. Товары полностью зарезервировались - формируется и возвращается новый статус с кодом 200 на заголовок.
    2. Товары полностью не зарезервировались - формируется и возвращается новый статус с кодом 202 на заголовок.
    3. Товары зарезервировались частично - формируется и возвращается новый статус с кодом 201 на заголовок, а так же возвращаются строки заказа, по которым не хватило количества в наличии
  • Сбор (комплектация) заказа
    После того как заказ в аптеке был собран (укомплектован), необходимо отправить статус на заголовок 213. Отправка этого статуса инициируется из аптечного ПО, после того как сотрудник аптеки выставил в ПО АналаитФАРМАЦИЯ статус полной комплектации заказа. 
  • Отмена заказа аптекой
    При отмене заказа формируется и возвращается новый статус (с новым уникальным идентификатором) отмены заказа по инициативе аптеки с кодом 212. Заказ снимается с резерва.
  • Сброс резерва
    Если товар не был выкуплен, то товар снимается с резерва, и формируется и возвращается новый статус (с новым уникальным идентификатором) с кодом 205. Заказ снимается с резерва. (не реализовано)
  • Выкуп заказа
    Если заказ был полностью выкуплен, то формируется и возвращается статус с кодом 210.

Статусы заказов, формируемые аптекой

Код Название Описание
200 Accepted Заказ принят аптекой. Формируется на заголовок
201 PartiallyAccepted Заказ частично принят аптекой. Формируется на заголовок
202 Rejected Отказ со стороны аптеки. Формируется на заголовок
205 ReserveCancelled Резерв сброшен. Формируется на заголовок
210 Purchased Заказ выкуплен. Формируется на заголовок
213 Assembled Заказ собран (укомплектован). Формируется на заголовок

Получение токена

Для выполнения запросов к API, необходимо получить JWT токен по адресу https://yavapteke.ru/YavaptekeAPI/connect/token 
POST /connect/token

Описание

Параметры запроса

Заголовки запроса

Пример запроса

Успешный ответ

Пример ответа

Неуспешный ответ

Получение информации о заказах аптеки

Клиенты, которые работают с сайтом yaVapteke, могут получать через API информацию о новых заказах, сформированных на сайте, а также информацию об изменении статусов этих заказов.
GET /v5/stores/{storeId}/orders_exchanger

Описание

Параметры запроса

Заголовки запроса

Пример запроса

Успешный ответ

Пример ответа

Объект ответа

Объект ответа Header(заголовок)

Объект ответа Row(строка заказа)

Объект ответа Status(строка статуса)

Неуспешный ответ

Отправка информации о заказах

Клиенты, которые работают с заказами с сайта yaVapteke.ru, должны передавать информацию об изменениях в заказах, произошедших в аптеке, а также информацию о статусе заказов.
PUT v5/stores/{storeId}/orders_exchanger

Описание

Параметры запроса

Заголовки запроса

Тело запроса

Пример запроса

Успешный ответ

Пример ответа

Неуспешный ответ