Метод добавляет аппаратный ключ к заказу, идентификатор которого передан в параметре пути {order_id}.

 Заказ должен быть в статусе Подтвержден (Submit). 

Адрес/v1.0/orders/{order_id}/dongles
ТипPOST
LoginТребуется 

Входные параметры

Входные параметры передаются в теле запроса в raw JSON:  

ПараметрОбязательностьОписаниеВозможные значения

dongleId

Обязателен

Идентификатор аппаратного ключа  (выгравирован на корпусе).

Добавление аппаратного ключа с dongleId, который совпадает с ранее добавленным в заказ запрещено


dongleModel

ОбязателенМодель аппаратного ключа

 

publicCode

ОбязателенЧисловое значение публичного кода доступа вендора


typeFlags

ОбязателенПоле Type аппаратного ключа, которые определяет его свойства (поддержку алгоритмов, сетевого функционала и т. п.)

netResource

ОбязателенCетевой ресурс аппаратного ключа
Пример запроса
https://station.guardant.ru/v1.0/orders/1053/dongles
Пример тела запроса
{
	"dongleId": 991846791,
	"dongleModel": 2,
	"publicCode": 1368487351,
	"typeFlags": 0,
	"netResource": 0
}

Ответ

Возвращает элемент dongle:

Пример результата запроса
"dongle": {
 "dongleid": 991846791,
 "model": 2,
 "netresource": 0,
 "publiccode": 1368487351,
 "typeflags": 0
}

При добавление аппаратного ключа к заказу могут быть получены следующие дополнительные ошибки:

  • ключ не поддерживает ограниченные по времени компоненты (код ошибки 10172);
  • ключ не поддерживает сетевой компонент (код ошибки 10173);
  • общее количество сетевых компонентов превышает сетевой ресурс ключа (код ошибки 10174).

При получении ошибок 10172 и 10173 в ответе на запрос помимо описания ошибки также будут следующе поля: ID аппаратного ключа, номер компонента, номер продукта, номер заказа. Например:

Пример результата запроса с ошибкой
{
   "conflictedDongleId":999392418,
   "conflictedFeatureNumber":16,
   "conflictedOrderNumber":94,
   "conflictedProductNumber":12350,
   "status":{"code":10172,"description":"Dongle does not support time limited features","message":"Bad Request","status":400}
}

При получении ошибки 10174 в ответе на запрос помимо описания ошибки будет только значение ID аппаратного ключа. 

  • No labels