Документация API
Сервис предоставляет программный доступ к определению кодов ТН ВЭД по наименованию товара и к сокращению длинных наименований товаров. Все запросы и ответы выполняются в формате JSON (кодировка UTF-8).
Авторизация
Доступ к API предоставляется по ключу. Ключ выдаётся администратором сервиса по запросу. При каждом запросе необходимо передать заголовок:
Authorization: Bearer <ваш ключ>
При отсутствии ключа или его недействительности сервис возвращает ошибку 401.
Методы
| Метод | Путь | Описание |
|---|---|---|
| GET | /api/health |
Проверка доступности сервиса. Авторизация не требуется. |
| POST | /api/classify |
Определение кодов ТН ВЭД по наименованию товара. Возвращает пять наиболее вероятных кодов с характеристиками позиции. |
| POST | /api/shorten |
Сокращение длинного наименования товара до краткой формы. |
Определение кода ТН ВЭД
Запрос:
POST /api/classify
Authorization: Bearer <ключ>
Content-Type: application/json
{"text": "маска для лица"}
Ответ:
{"results": [
{"code": "3304990000", "probability": 0.921869,
"title": "Косметические средства или средства для макияжа и средства для ухода за кожей (кроме лекарственных)…",
"tariff": "6.5%"},
{"code": "6117808000", "probability": 0.0102,
"title": "Принадлежности к одежде трикотажные машинного или ручного вязания готовые прочие…",
"tariff": "10%"},
…
]}
Поля ответа: code — код ТН ВЭД; probability — вероятность;
title — наименование позиции номенклатуры; tariff — тариф.
Поля title и tariff присутствуют, если код найден в номенклатуре.
Сокращение наименования товара
Запрос:
POST /api/shorten
Authorization: Bearer <ключ>
Content-Type: application/json
{"text": "набор банок для хранения pasabahce cesni 0,5 л, 3 шт 97424"}
Ответ:
{"shortened": "набор банок для хранения"}
Коды ответов
| Код | Значение |
|---|---|
| 200 | Запрос выполнен успешно |
| 400 | Недопустимый запрос: отсутствует или пусто поле text |
| 401 | Не авторизован: отсутствует или недействителен ключ |
| 502 | Сервис временно недоступен. Повторите запрос позже |