API онлайн-сервиса Подбор кода: различия между версиями

Материал из Alta-Soft Wikipedia
Перейти к навигации Перейти к поиску
м (Admin переименовал страницу XML-API Подбор кода в API-XML Подбор кода без оставления перенаправления)
(нет различий)

Версия 17:36, 25 марта 2022

О сервисе

Сервис «Подбор кода» является алфавитно-предметным указателем, позволяющим сопоставить наименование товара с конечным кодом ТН ВЭД.

Определение кода происходит в два этапа:

  • Получение списка подсказок-словосочетаний по введенному слову
  • Получение кодов ТН ВЭД по выбранному словосочетанию

При выдаче подсказок и кодов ТН ВЭД записи отсортированы с учетом вероятности, от максимальной к минимальной.

API

Доступ к API предоставляется по URL https://www.alta.ru/tnved/xml_apu/

Входные параметры передаются с помощью запроса HTTP GET.

Получение списка подсказок, а также идентификаторов подсказок и наборов подходящих групп ТН ВЭД

Для получения списка подсказок, а также идентификаторов подсказок и наборов подходящих групп ТН ВЭД, необходимо в GET-запросе передать параметр q, содержащий искомый текст.

Пример запроса: https://www.alta.ru/tnved/xml_apu/?q=пилы

Для получения определенного количества подсказок необходимо передать GET-параметр limit. Возможные значения: -1 (неограниченное количество подсказок) или любое положительное число.

XML-ответ:

result Корневой элемент документа
line Элемент с информацией о подсказке
term Текст подсказки
tngroup Набор подходящих групп ТНВЭД
payload Идентификатор подсказки
weight Приоритет подсказки

Получение списка кодов ТН ВЭД и весов

Для использования сервиса с целью получения списка кодов ТНВЭД и весов по идентификатору подсказки необходима авторизация с помощью сервисного логина и пароля. Для авторизации с помощью пары логин/пароль необходимо в GET-запрос добавить логин в открытом виде и MD5-хеш от сгенерированной строки Идентификатор подсказки + логин + md5-хэш от пароля, разделенный знаком двоеточия «:», например для пользователя с логином testlogin и паролем testpassword:
для запроса: https://www.alta.ru/tnved/xml_apu/?code=112675973&login=testlogin
вычисляем секрет: secret = md5("112675973:testlogin:md5(testpassword)")
итоговый URL: https://www.alta.ru/tnved/xml_apu/?code=112675973&login=testlogin&secret=8d43448578371c8a247c82223014e9a0


Для тестового подключения и предварительной настройки используйте:
логин: testlogin
пароль: testpassword
Для тестового пользователя доступны идентификаторы подсказок: 112675973, 114886448


Пример запроса: https://www.alta.ru/tnved/xml_apu/?code=112675973&login=testlogin&secret=8d43448578371c8a247c82223014e9a0

Для получения определенного количества кодов необходимо передать GET-параметр limit. Возможные значения: -1 (неограниченное количество подсказок) или любое положительное число.

XML-ответ:

result Корневой элемент документа
line Элемент с информацией о подсказке
tnved Код ТН ВЭД
weight Вес кода. Чем больше вес, тем больше вероятность, что это подходящий код.
descr Наименование ТН ВЭД
descr_sh Описание ТН ВЭД
tncode Код ТН ВЭД в формате NNNN NN NNN N

Ошибки

При возникновении ошибки в корневом элементе появляется блок с кодом и описанием ошибки.
При работе с сервисом возможны следующие ошибки:

Код Описание
100 Пользователь не авторизован
110 Лимит запросов для данного пользователя исчерпан
120 Ошибка тарификации
200 Не указана строка или код поиска
200 Нет информации
201 Указан нулевой лимит при запросе


Примеры ошибок

Пользователь не авторизован:
https://www.alta.ru/tnved/xml_apu/?code=114886448&login=testlogin&secret=8d43448578371c8a247c82223014e9a0

Лимит запросов для данного пользователя исчерпан:
https://www.alta.ru/tnved/xml_apu/?code=114886448&login=testloginlimit&secret=1120a0a9187217ac2ab6d3f0acec0a86

Не указана строка или код поиска:
https://www.alta.ru/tnved/xml_apu/

Указан нулевой лимит при запросе:
https://www.alta.ru/tnved/xml_apu/?code=114886448&login=testlogin&secret=4c83f2d0a098d36406b98765181a549c&limit=0