Docs API - Публичная документация - Красная мина

Получение авторизационного токена

Параметры этого запроса передаются в теле запроса, см. пример запроса

Имя	Обяз.	Описание
client_id	•	Идентификатор клиента
secret	•	Пароль клиента, полученный
grant_type		Тип авторизации. В данном случае всегда client_credentials

Имя	Описание
Content-Type	Должно иметь значение application/x-www-form-urlencoded

HTTP

POST /connect/token HTTP/1.1
Host: yaVapteke.ru/YavaptekeAPI/
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
client_id=3f37b142-e371-461e-924c-a913ff878534&client_secret=Pas$w0Rd

C# (RestSharp)

var client = new RestClient(" https://yavapteke.ru/YavaptekeAPI/connect/token");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("client_id", " 3f37b142-e371-461e-924c-a913ff878534");
request.AddParameter("client_secret", "Pas$w0Rd");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

CURL

curl --location --request POST 'https://yavapteke.ru/YavaptekeAPI/connect/token' --header 'Content-Type: application/x-www-form-urlencoded' --data-urlencode 'client_id= 3f37b142-e371-461e-924c-a913ff878534' --data-urlencode 'client_secret=Pas$w0Rd'

HTTP cтатус	Значение
200	ОК. Запрос к сервису авторизации прошел успешно, в теле ответа содержится JSON с информацией о выданном токене.

{
    "access_token": "08da627f-6773-4112-8355-47c94c7ac717",
    "expires_in": 3600,
    "token_type": "Bearer" 
}

HTTP статус	Значение
400	Полученные службой данные содержат ошибки. Информация об ошибке возвращается в теле ответа.
500	Ошибка сервиса. Если ошибка повторяется, сообщите, пожалуйста, разработчикам сервиса

Получить информацию по заказам аптеки storeId по протоколу v5

Имя	Тип	Обяз.	Описание
storeId	GUID	•	Идентификатор аптеки по справочнику yaVapteke
since	datetime		Дата, с которой необходимо получить изменения (не включительно) в формате ISO8601
orderId	GUID		Уникальный код заказа
excludeOwn	bool		Исключать или не исключать собственные изменения, по умолчанию true, т.е. при запросе изменений с какой-либо даты, вы получите в ответ только изменения, созданные сайтом, иначе получите назад и созданные аптекой статусы.

Если в запросе указать excludeOwn=false, то при запросе изменений с какой-либо даты, вы получите в ответ получите изменения созданные сайтом и созданные аптекой статусы.
Таким образом можно получить всю историю статусов по заказам начиная с указанной даты.

ВНИМАНИЕ! При запросе изменений по заказам, всегда задавайте параметр since следующего запроса равным максимальному значению поля Date объекта запроса Status.

Имя	Описание
Authorization	Bearer token
Accept	application/json или application/x-json-full

 GET /v5/stores/638f97ee-2675-11ed-9d91-051517d411ac/orders_exchanger?since=2022-08-25T16:45:42.614983 HTTP/1.1  
 Host: yavapteke.ru/YavaptekeAPI/
 Authorization: Bearer   08da627f-6773-4112-8355-47c94c7ac717
 Content-Type: application/json
 Cache-Control: no-cache

HTTP cтатус	Значение
200	ОК. Успешный запрос. Тело запроса содержит объект заказов

{
    "headers": [
        {
            "orderId": "8983235b-cd45-417a-b520-42e364d02e95",
            "storeId": "638f97ee-2675-11ed-9d91-051517d411ac",
            "issuerId": "638f97ee-2675-11ed-9d91-051517d411ac",
            "src": null,
            "num": "4014",
            "date": "2022-08-25T16:04:58+03:00",
            "name": "Виталий",
            "mPhone": "+79507537272",
            "payType": null,
            "payTypeId": null,
            "summary": null,
            "ae": null,
            "unionId": null,
            "ts": "2022-08-25T16:10:47+03:00",
            "delivery": null,
            "deliveryInfo": null,
            "srcDesc": null
        }
    ],
    "rows": [
        {
            "rowId": "db55190a-82b8-472a-aebd-9051eb77d8b1",
            "orderId": "8983235b-cd45-417a-b520-42e364d02e95",
            "storeId": "638f97ee-2675-11ed-9d91-051517d411ac",
            "rowType": 0,
            "prtId": null,
            "nnt": 6608,
            "qnt": 1,
            "prc": 168,
            "prcDsc": null,
            "dscUnion": null,
            "dtn": null,
            "prcLoyal": null,
            "prcOptNds": null,
            "supInn": null,
            "dlvDate": null,
            "qntUnrsv": null,
            "prcFix": null,
            "ts": null,
            "mark": null
        }
    ],
    "statuses": [
        {
            "statusId": "08da869b-133d-44b2-8abc-c8da458047d3",
            "orderId": "8983235b-cd45-417a-b520-42e364d02e95",
            "rowId": null,
            "storeId": "638f97ee-2675-11ed-9d91-051517d411ac",
            "date": "2022-08-25T16:09:42.709034+03:00",
            "status": 100,
            "rcDate": "2022-08-25T16:09:42.709034+03:00",
            "cmnt": null,
            "ts": null
        }
    ]
}

Имя	Тип	Описание
headers	Header[]	Массив заголовков заказов
rows	Row[]	Массив строк заказов
statuses	Status[]	Массив статусов заказов

Имя	Тип	Описание
orderId	GUID	Уникальный код заказа.
storeId	GUID	Уникальный код аптеки, на которой сделан заказ
issuerId	GUID	Уникальный код аптеки, которая выдает заказ (для самовывоза)
src	string	Источник заказа
num	string	Номер заказа
date	datetime	Дата заказа в формате ISO8601 с указанием часового пояса
name	string	Имя покупателя
mPhone	string	Номер телефона
payType	string	Тип оплаты
payTypeId	int	ИД типа оплаты
summary	string	Дисконтная карта
ae	int
unionId	GUID	ИД совместной покупки
ts	datetime	Отметка времени, в формате ISO8601. Представляет собой дату и время создания или обновления заголовка сервисом yaVapteke
delivery	bool
deliveryInfo	string
srcDesc	string

Имя	Тип	Описание
rowId	GUID	Уникальный код строки заказа
orderId	GUID	Уникальный код заказа
storeId	GUID	Уникальный код аптеки, на которой сделан заказ
rowType	int	Тип строки (0 - наличие, 1 - предзаказ)
prtId	string	Уникальный код партии. На данный момент не возвращается
nnt	int	Код товара (Ваш внутренний Код товара, выгружаемый в прайс-листе в поле CODE)
qnt	float	Количество в заказе
prc	decimal	Цена товара в момент заказа
prcDsc	decimal	Цена товара, обещанная покупателю в момент оформления заказа
dscUnion	string	Признак дисконта
dtn	decimal	Дотация для единицы товара.
prcLoyal	decimal	Цена реализации со скидкой
prcOptNds	decimal	Цена поставки
supInn	string	ИНН поставщика
dlvDate	datetime	Дата поставки в формате ISO8601
qntUnrsv	float	Количество незарезервированного товара
prcFix	decimal	Фиксированная цена
ts	datetime	Отметка времени, в формате ISO8601. Представляет собой дату и время создания или обновления строки сервисом yaVapteke
mark	int

Имя	Тип	Описание
statusId	GUID	Уникальный код статуса
orderId	GUID	Уникальный код заказа
rowId	GUID	Уникальный код строки заказа (заполняется только если статус на строку)
storeId	GUID	Уникальный код аптеки
date	datetime	Дата и время статуса
status	int	Код статуса
rcDate	datetime	Дата и время сброса резерва в формате ISO8601. Поле заполняется только для 100, 108 ,104 статусов заказа
cmnt	string	Комментарий
Ts	datetime	Отметка времени, в формате ISO8601. Представляет собой дату и время создания или обновления статуса сервисом yaVapteke(в нулевом часовом поясе)

HTTP статус	Значение
400	Bad Request. Полученные службой данные содержат ошибки. Информация об ошибке возвращается в теле ответа.
401	Unauthorized. Токен авторизации неверный или истек срок его действия.
403	Forbidden. У вас нет прав на выполнение данной операции.
429	Too Many Requests. Слишком много запросов с одного IP адреса за промежуток времени.
500	Internal Server Error. Ошибка сервиса. Если ошибка повторяется, сообщите, пожалуйста, разработчикам сервиса.

Передать информацию по заказам аптеки storeId по протоколу v5

Имя	Тип	Обяз.	Описание
storeId	GUID	•	Идентификатор аптеки по справочнику yaVapteke

Имя	Описание
Authorization	Bearer token
Content-Type	application/json

Объект запроса

Имя	Тип	Обяз.	Описание
rows	Row[]		Массив строк заказов
statuses	Status[]		Массив статусов заказов

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

Имя	Тип	Обяз.	Описание
rowId	GUID	•	Уникальный код строки заказа
qntUnrsv	float	•	Количество незарезервированного товара

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

Имя	Тип	Обяз.	Описание
statusId	GUID	•	Уникальный код статуса. Генерируется клиентским ПО
orderId	GUID	•	Уникальный код заказа. Берется из обрабатываемого заказа
rowId	GUID		Уникальный код строки заказа (заполняется только если статус на строку). Берется из обрабатываемого заказа
storeId	GUID	•	Уникальный код аптеки. Берется из обрабатываемого заказа
date	datetime	•	Дата и время создания статуса в формате ISO8601 с указанием часового пояса
status	int	•	Код статуса
rcDate	datetime		Дата и время сброса резерва в формате ISO8601 с указанием часового пояса. Поле заполняется только для 204 статуса заказа
cmnt	string		Комментарий

Примерно частичного подтверждения заказа.¶

PUT /v5/stores/638f97ee-2675-11ed-9d91-051517d411ac/orders_exchanger HTTP/1.1
Host: yavapteke.ru/YavaptekeAPI/
Authorization: Bearer 08da627f-6773-4112-8355-47c94c7ac717
Content-Type: application/json
Cache-Control: no-cache
{
    "rows": [
        {
        "rowId": "db55190a-82b8-472a-aebd-9051eb77d8b1",
        "qntUnrsv": 1
        }
    ],
    "statuses": [
        {
        "statusId": "08da869b-133d-44b2-8abc-c8da458047d3",
        "orderId": "8983235b-cd45-417a-b520-42e364d02e95",
        "storeId": "638f97ee-2675-11ed-9d91-051517d411ac",
        "date": "2022-08-25T16:09:42.709034+03:00",
        "rcDate": "2022-08-25T16:09:42.709034+03:00",
        "status": 201
        }
    ]
}

Статус 201 служит промежуточным для передачи информации о незарезервированном количестве товара. После него обязательно необходима отправка сообщения со статусом 213, после чего статус заказа изменяется на "Готов к выдаче" и покупателю отправляется СМС о готовности. В теге "rows" передаются только те строки заказа, по которым существует незарезервированное количество. Например в заказе 3 шт., а в наличии только 2, необходимо отправить "qntUnrsv": 1

Пример полного подтверждения заказа.

PUT /v5/stores/638f97ee-2675-11ed-9d91-051517d411ac/orders_exchanger HTTP/1.1
Host: yavapteke.ru/YavaptekeAPI/
Authorization: Bearer 08da627f-6773-4112-8355-47c94c7ac717
Content-Type: application/json
Cache-Control: no-cache
{
    
    "statuses": [
        {
        "statusId": "08da869b-133d-44b2-8abc-c8da458047d3",
        "orderId": "8983235b-cd45-417a-b520-42e364d02e95",
        "storeId": "638f97ee-2675-11ed-9d91-051517d411ac",
        "date": "2022-08-25T16:09:42.709034+03:00",
        "rcDate": "2022-08-25T16:09:42.709034+03:00",
        "status": 200
        }
    ]
}

ВНИМАНИЕ! После отправки статуса 200 или 201, даже если заказ подтвержден частично, ОБЯЗАТЕЛЬНО требуется отправка статуса 213.
Только после этого статус заказа в системе измениться на "Готов к выдаче" и покупателю будет отправлено СМС о готовности заказа. (За исключением того случая, когда заказ необходимо отменить полностью, в этом случае отправляется статус 202)

Пример отправки подтверждения готовности заказа.

PUT /v5/stores/638f97ee-2675-11ed-9d91-051517d411ac/orders_exchanger HTTP/1.1
Host: yavapteke.ru/YavaptekeAPI/
Authorization: Bearer 08da627f-6773-4112-8355-47c94c7ac717
Content-Type: application/json
Cache-Control: no-cache
{
    
    "statuses": [
        {
        "statusId": "08da869b-133d-44b2-8abc-c8da458047d3",
        "orderId": "8983235b-cd45-417a-b520-42e364d02e95",
        "storeId": "638f97ee-2675-11ed-9d91-051517d411ac",
        "date": "2022-08-25T16:10:42.709034+03:00",
        "rcDate": "2022-08-25T16:10:42.709034+03:00",
        "status": 213
        }
    ]
}

HTTP cтатус	Значение
201	Created. Данные успешно записаны

HTTP/1.1 201 Created

HTTP статус	Значение
400	Bad Request. Полученные службой данные содержат ошибки. Информация об ошибке возвращается в теле ответа.
401	Unauthorized. Токен авторизации неверный или истек срок его действия
403	Forbidden. У вас нет прав на выполнение данной операции
429	Too Many Requests. Слишком много запросов с одного IP адреса за промежуток времени
500	Internal Server Error. Ошибка сервиса. Если ошибка повторяется, сообщите, пожалуйста, разработчикам сервиса

Код	Название	Описание
100	New	Новый заказ

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

clipboard-202208261439-epb74.png (72.8 KB) clipboard-202208261439-epb74.png		Дорошев Виталий, 26.08.2022 11:39
clipboard-202208261441-wdg6m.png (155 KB) clipboard-202208261441-wdg6m.png		Дорошев Виталий, 26.08.2022 11:41
Схема API2.jpg (70.9 KB) Схема API2.jpg		Дорошев Виталий, 27.03.2023 11:02

Project

General

Profile

Публичная документация

Wiki

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

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

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

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

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

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

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

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

Примерно частичного подтверждения заказа.¶