Раздел API

Маркировка

Модуль маркировки: проверка кодов в Честном знаке (ТС ПИоТ, локальный модуль, ГИС МТ) перед продажей и коды в чеке.

Проверка кодов маркировки в Честном знаке (разрешительный режим)

GET	`/api/v1/marking/settings`	Настройки модуля маркировки
PUT	`/api/v1/marking/settings`	Изменить настройки модуля маркировки
POST	`/api/v1/marking/check`	Проверить коды маркировки: можно ли продать
GET	`/api/v1/marking/status`	Состояние модуля маркировки
GET	`/api/v1/marking/recent`	Последние проверки кодов

Настройки модуля маркировки#

GET/api/v1/marking/settings

Пароль и токены — «********», если заданы

Ответ 200 application/json

Поля · MarkingSettings

enabledboolean
sourcesмассив string
piotUrlstring
lmUrlstring
lmLoginstring
lmPasswordstring
tokenstring
sandboxboolean
fnNumberstring
timeoutMsinteger int32
offlineSaleboolean
clientIdstring
clientTokenstring

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl 'http://localhost:7790/api/v1/marking/settings'

curl

curl 'https://cloud.hw-connector.ru/agent/api/v1/marking/settings' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Изменить настройки модуля маркировки#

PUT/api/v1/marking/settings

«********» в пароле и токенах — оставить прежние

Тело запроса application/json обязательное

Поля · MarkingSettings

enabledboolean
sourcesмассив string
piotUrlstring
lmUrlstring
lmLoginstring
lmPasswordstring
tokenstring
sandboxboolean
fnNumberstring
timeoutMsinteger int32
offlineSaleboolean
clientIdstring
clientTokenstring

JSON

{
  "enabled": false,
  "sources": [
    "string"
  ],
  "piotUrl": "string",
  "lmUrl": "string",
  "lmLogin": "string",
  "lmPassword": "string",
  "token": "string",
  "sandbox": false,
  "fnNumber": "string",
  "timeoutMs": 1,
  "offlineSale": false,
  "clientId": "string",
  "clientToken": "string"
}

Ответ 200 application/json

Поля · MarkingSettings

enabledboolean
sourcesмассив string
piotUrlstring
lmUrlstring
lmLoginstring
lmPasswordstring
tokenstring
sandboxboolean
fnNumberstring
timeoutMsinteger int32
offlineSaleboolean
clientIdstring
clientTokenstring

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl -X PUT 'http://localhost:7790/api/v1/marking/settings' \
  -H 'Content-Type: application/json' \
  --data '{"enabled":false,"sources":["string"],"piotUrl":"string","lmUrl":"string","lmLogin":"string","lmPassword":"string","token":"string","sandbox":false,"fnNumber":"string","timeoutMs":1,"offlineSale":false,"clientId":"string","clientToken":"string"}'

curl

curl -X PUT 'https://cloud.hw-connector.ru/agent/api/v1/marking/settings' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Content-Type: application/json' \
  --data '{"enabled":false,"sources":["string"],"piotUrl":"string","lmUrl":"string","lmLogin":"string","lmPassword":"string","token":"string","sandbox":false,"fnNumber":"string","timeoutMs":1,"offlineSale":false,"clientId":"string","clientToken":"string"}'

Проверить коды маркировки: можно ли продать#

POST/api/v1/marking/check

Спрашивает ТС ПИоТ, локальный модуль ЧЗ или ГИС МТ (по настройкам) и применяет правила разрешительного режима. В ответе по каждому коду allowed, причины отказа и industryProps — их можно передать в позицию чека (marking.industryProps), тогда агент не проверяет код второй раз

Тело запроса application/json обязательное

Поля · CheckRequest

typestring
значения: SELL SELL_RETURN BUY BUY_RETURN
registerIdinteger int32
codesмассив CodeRequestобязательное
от 1
3 поля · CodeRequest
- codestringобязательное
  от 1
- priceinteger int64
- fractionstring

JSON

{
  "type": "SELL",
  "registerId": 1,
  "codes": [
    {
      "code": "string",
      "price": 1,
      "fraction": "string"
    }
  ]
}

Ответ 200 application/json

Поля · Check

allowedboolean
itemsмассив Result
11 полей · Result
- codestring
- cisstring
- gtinstring
- allowedboolean
- reasonsмассив string
- warningsмассив string
- sourcestring
- offlineboolean
- industryPropsstring
- infoCodeInfo
  20 полей · CodeInfo
  - cisstring
  - gtinstring
  - foundboolean
  - validboolean
  - utilisedboolean
  - verifiedboolean
  - realizableboolean
  - soldboolean
  - blockedboolean
  - ogvsмассив string
  - grayZoneboolean
  - expireDatestring date
  - groupIdsмассив integer int32
  - mrpinteger int64
  - smpinteger int64
  - innerUnitCountinteger int32
  - errorCodeinteger int32
  - messagestring
  - packageTypestring
  - ownerboolean
- checkedAtstring date-time

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl -X POST 'http://localhost:7790/api/v1/marking/check' \
  -H 'Content-Type: application/json' \
  --data '{"type":"SELL","registerId":1,"codes":[{"code":"string","price":1,"fraction":"string"}]}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/marking/check' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Content-Type: application/json' \
  --data '{"type":"SELL","registerId":1,"codes":[{"code":"string","price":1,"fraction":"string"}]}'

Состояние модуля маркировки#

GET/api/v1/marking/status

Включён ли, есть ли лицензия, доступны ли ТС ПИоТ, локальный модуль и ГИС МТ

Ответ 200 application/json

Тип: словарь → любое значение

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl 'http://localhost:7790/api/v1/marking/status'

curl

curl 'https://cloud.hw-connector.ru/agent/api/v1/marking/status' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Последние проверки кодов#

GET/api/v1/marking/recent

До 50 последних, новые сверху

Ответ 200 application/json

Массив · Result

codestring
cisstring
gtinstring
allowedboolean
reasonsмассив string
warningsмассив string
sourcestring
offlineboolean
industryPropsstring
infoCodeInfo
20 полей · CodeInfo
- cisstring
- gtinstring
- foundboolean
- validboolean
- utilisedboolean
- verifiedboolean
- realizableboolean
- soldboolean
- blockedboolean
- ogvsмассив string
- grayZoneboolean
- expireDatestring date
- groupIdsмассив integer int32
- mrpinteger int64
- smpinteger int64
- innerUnitCountinteger int32
- errorCodeinteger int32
- messagestring
- packageTypestring
- ownerboolean
checkedAtstring date-time

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl 'http://localhost:7790/api/v1/marking/recent'

curl

curl 'https://cloud.hw-connector.ru/agent/api/v1/marking/recent' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'