API онлайн-сервиса Подбор кода: различия между версиями
(Новая страница: «==О сервисе== Сервис «Подбор кода» предоставляет разработчикам возможность получения ин…») |
Admin (обсуждение | вклад) м (Admin переименовал страницу API-XML Подбор кода в API онлайн-сервиса Подбор кода без оставления перенаправления) |
||
(не показано 7 промежуточных версий 2 участников) | |||
Строка 1: | Строка 1: | ||
==О сервисе== | ==О сервисе== | ||
− | Сервис «Подбор кода» | + | Сервис «Подбор кода» является алфавитно-предметным указателем, позволяющим сопоставить наименование товара с конечным кодом ТН ВЭД. |
− | + | Определение кода происходит в два этапа: | |
− | |||
− | + | *Получение списка подсказок-словосочетаний по введенному слову | |
− | + | *Получение кодов ТН ВЭД по выбранному словосочетанию | |
− | + | При выдаче подсказок и кодов ТН ВЭД записи отсортированы с учетом вероятности, от максимальной к минимальной. | |
+ | ==API== | ||
+ | Доступ к API предоставляется по URL https://www.alta.ru/tnved/xml_apu/ | ||
Входные параметры передаются с помощью запроса HTTP GET. | Входные параметры передаются с помощью запроса HTTP GET. | ||
− | ===Получение списка подсказок, а также идентификаторов подсказок и наборов подходящих групп | + | ===Получение списка подсказок, а также идентификаторов подсказок и наборов подходящих групп ТН ВЭД=== |
− | Для получения списка подсказок, а также идентификаторов подсказок и наборов подходящих групп | + | Для получения списка подсказок, а также идентификаторов подсказок и наборов подходящих групп ТН ВЭД, необходимо в GET-запросе передать параметр q, содержащий искомый текст. |
Пример запроса: https://www.alta.ru/tnved/xml_apu/?q=пилы | Пример запроса: https://www.alta.ru/tnved/xml_apu/?q=пилы | ||
Строка 24: | Строка 25: | ||
|result||Корневой элемент документа | |result||Корневой элемент документа | ||
|- | |- | ||
− | |line|| Элемент с информацией о подсказке | + | |line||Элемент с информацией о подсказке |
|- | |- | ||
|term||Текст подсказки | |term||Текст подсказки | ||
|- | |- | ||
− | | | + | |tngroup||Набор подходящих групп ТНВЭД |
|- | |- | ||
− | |weight|| Приоритет подсказки | + | |payload||Идентификатор подсказки |
+ | |- | ||
+ | |weight||Приоритет подсказки | ||
|- | |- | ||
|} | |} | ||
− | ===Получение списка кодов | + | ===Получение списка кодов ТН ВЭД и весов=== |
Для использования сервиса с целью получения списка кодов ТНВЭД и весов по идентификатору подсказки необходима авторизация с помощью сервисного логина и пароля. | Для использования сервиса с целью получения списка кодов ТНВЭД и весов по идентификатору подсказки необходима авторизация с помощью сервисного логина и пароля. | ||
'''Для авторизации с помощью пары логин/пароль''' необходимо в GET-запрос добавить логин в открытом виде и MD5-хеш от сгенерированной строки '''Идентификатор подсказки + логин + md5-хэш от пароля''', разделенный знаком двоеточия «:», например для пользователя с логином testlogin и паролем testpassword:<br> | '''Для авторизации с помощью пары логин/пароль''' необходимо в GET-запрос добавить логин в открытом виде и MD5-хеш от сгенерированной строки '''Идентификатор подсказки + логин + md5-хэш от пароля''', разделенный знаком двоеточия «:», например для пользователя с логином testlogin и паролем testpassword:<br> | ||
− | для запроса: https:// | + | для запроса: https://www.alta.ru/tnved/xml_apu/?code=112675973&login=testlogin <br> |
вычисляем секрет: secret = md5("112675973:testlogin:md5(testpassword)")<br> | вычисляем секрет: secret = md5("112675973:testlogin:md5(testpassword)")<br> | ||
− | итоговый URL: https:// | + | итоговый URL: https://www.alta.ru/tnved/xml_apu/?code=112675973&login=testlogin&secret=8d43448578371c8a247c82223014e9a0 |
---- | ---- | ||
Строка 49: | Строка 52: | ||
</code> | </code> | ||
---- | ---- | ||
− | Пример запроса: https:// | + | Пример запроса: https://www.alta.ru/tnved/xml_apu/?code=112675973&login=testlogin&secret=8d43448578371c8a247c82223014e9a0 |
Для получения определенного количества кодов необходимо передать GET-параметр limit. Возможные значения: -1 (неограниченное количество подсказок) или любое положительное число. | Для получения определенного количества кодов необходимо передать GET-параметр limit. Возможные значения: -1 (неограниченное количество подсказок) или любое положительное число. | ||
Строка 58: | Строка 61: | ||
|result||Корневой элемент документа | |result||Корневой элемент документа | ||
|- | |- | ||
− | |line|| Элемент с информацией о подсказке | + | |line||Элемент с информацией о подсказке |
|- | |- | ||
|tnved||Код ТН ВЭД | |tnved||Код ТН ВЭД | ||
|- | |- | ||
− | |weight|| Вес кода. Чем больше вес, тем больше вероятность, что это подходящий код. | + | |weight||Вес кода. Чем больше вес, тем больше вероятность, что это подходящий код. |
|- | |- | ||
− | |descr|| Наименование ТН ВЭД | + | |descr||Наименование ТН ВЭД |
|- | |- | ||
− | |descr_sh|| Описание ТН ВЭД | + | |descr_sh||Описание ТН ВЭД |
|- | |- | ||
− | |tncode|| Код ТН ВЭД в формате NNNN NN NNN N | + | |tncode||Код ТН ВЭД в формате NNNN NN NNN N |
|- | |- | ||
|} | |} | ||
Строка 87: | Строка 90: | ||
|- | |- | ||
|200||Не указана строка или код поиска | |200||Не указана строка или код поиска | ||
+ | |- | ||
+ | |200||Нет информации | ||
|- | |- | ||
|201||Указан нулевой лимит при запросе | |201||Указан нулевой лимит при запросе | ||
Строка 94: | Строка 99: | ||
==Примеры ошибок== | ==Примеры ошибок== | ||
Пользователь не авторизован:<br> | Пользователь не авторизован:<br> | ||
− | https:// | + | https://www.alta.ru/tnved/xml_apu/?code=114886448&login=testlogin&secret=8d43448578371c8a247c82223014e9a0 |
Лимит запросов для данного пользователя исчерпан:<br> | Лимит запросов для данного пользователя исчерпан:<br> | ||
− | https:// | + | https://www.alta.ru/tnved/xml_apu/?code=114886448&login=testloginlimit&secret=1120a0a9187217ac2ab6d3f0acec0a86 |
Не указана строка или код поиска:<br> | Не указана строка или код поиска:<br> | ||
− | https:// | + | https://www.alta.ru/tnved/xml_apu/ |
Указан нулевой лимит при запросе:<br> | Указан нулевой лимит при запросе:<br> | ||
− | https:// | + | https://www.alta.ru/tnved/xml_apu/?code=114886448&login=testlogin&secret=4c83f2d0a098d36406b98765181a549c&limit=0 |
[[Категория:Автоматизация]] | [[Категория:Автоматизация]] | ||
[[Категория:Web-Сервисы]] | [[Категория:Web-Сервисы]] | ||
[[Категория:Такса]] | [[Категория:Такса]] |
Текущая версия на 19:08, 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