Различия

Показаны различия между двумя версиями страницы.

--- ru:api_start [2022/05/25 19:21]
support
+++ ru:api_start [2023/03/28 21:49] (текущий)
support
@@ Строка 7: / Строка 7: @@
 >Для работы API необходимо установить API token для пользователя.
->>Bearer authentication это схема аутентификации HTTP, в которой используются маркеры безопасности, называемые bearer tokens. bearer token - это шифрованная строка, обычно генерируемая сервером в ответ на запрос на вход в систему. Клиент должен отправить этот токен в заголовке Authorization при формировании запроса: Authorization: Bearer <token>
+>>Bearer authentication это схема аутентификации HTTP, в которой используются маркеры безопасности, называемые bearer tokens. bearer token - это шифрованная строка. Клиент должен отправить этот токен в заголовке Authorization при формировании запроса: Authorization: Bearer <token>
 ----
->Перейдите в раздел управления пользователями (Settings -> Users)
+>Перейдите в раздел меню **Settings** - **Ysell API**
->Добавьте нового пользователя (необходимо заполнить поле API token случайным значением)
+>Создайте новый Access Token нажатием на Create New Token
->>{{:ru:api.png?700|}} {{:ru:api_1.png?500|}}
+>>{{:ru:apiysell2_1.png?300|}} {{:ru:apiysell_22.png?600|}}
+----
+>Перейдите в раздел Settings - ysell API
+>>{{:ru:apwi.png?600|}}
 ----
->Авторизуйтесь с помощью API token нажатием на Authorize
+>Авторизуйтесь с помощью API token нажатием на Authorize. Введите в строке аутентификации **Bearer** //сгенерированный API key//
->>{{:ru:api_23.png?600|}}
+>>{{:ru:api_23.png?600|}} {{:ru:apibearer_2.png?600|}}
 ====== Product ======
@@ Строка 845: / Строка 849: @@
 //Получение информации о отправке 719-1 //
 </WRAP>
->GET /prep-shipment Get prep shipment list - используется получения информации о отправке с Преп-центра.
+>**GET /prep-shipment Get prep shipment list** - используется получения информации о отправке с Преп-центра.
->company_id - ID компании.
+>
->shipment_num - номер шипмента
+>**company_id** - ID компании.
->shipment_type - тип шимента
+>
->shipment_type_description - описание типа отправки.
+>**shipment_num** - номер отправки
->status - статус шипмента.
+>
->status_description - описание статуса шипмента
+>**shipment_type** - тип отправки
->total_cost - цена за обработку отправки.
+>
->declared_qty - количество  единиц товара, указанного клиентом.
+>**shipment_type_description** - описание для типа отправки.
->declared_box_qty - количество коробок с товаром, указанного клиентом.,
+>
->processed_qty - обработанное Преп центром количество товара.
+>**status** - статус отправки.
->messages - текст примечания к отправке.
+>
+>**status_description** - описание статуса отправки
+>
+>**total_cost** - цена за обработку отправки.
+>
+>**declared_qty** - количество  единиц товара, указанного клиентом.
+>
+>**declared_box_qty** - количество коробок с товаром, указанного клиентом.
+>
+>**processed_qty** - обработанное Преп центром количество товара.
+>
+>**messages** - текст примечания к отправке.