API онлайн-сервиса Товары и Коды: различия между версиями
(Новая страница: «==О сервисе== XML-API «Товары и коды» позволяет интегрировать возможности сервиса в сторонни…») |
Admin (обсуждение | вклад) м (Admin переименовал страницу API-XML для ТиК онлайн в API онлайн-сервиса Товары и Коды без оставления перенаправления) |
||
| (не показано 7 промежуточных версий 2 участников) | |||
| Строка 7: | Строка 7: | ||
==API== | ==API== | ||
| − | Доступ к API предоставляется по URL https://www.alta.ru/tik/xml/. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью логина и пароля | + | Доступ к API предоставляется по URL https://www.alta.ru/tik/xml/. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля. |
'''Для авторизации с помощью пары логин/пароль''' необходимо в GET-запрос добавить логин в открытом виде и MD5-хеш от сгенерированной строки '''словосочетание + логин + пароль''', разделенный знаком двоеточия «:», например для пользователя с логином testlogin и паролем testpassword:<br> | '''Для авторизации с помощью пары логин/пароль''' необходимо в GET-запрос добавить логин в открытом виде и MD5-хеш от сгенерированной строки '''словосочетание + логин + пароль''', разделенный знаком двоеточия «:», например для пользователя с логином testlogin и паролем testpassword:<br> | ||
| − | Создаем запрос: https://www.alta.ru/tik/xml/?srchstr=зерно&login=testlogin | + | Создаем запрос: https://www.alta.ru/tik/xml/?srchstr=зерно&login=testlogin<br> |
| − | Вычисляем секрет: secret = md5("зерно:testlogin:testpassword") | + | Вычисляем секрет: secret = md5("зерно:testlogin:md5(testpassword)")<br> |
| − | Добавляем хеш-строку и получаем итоговый URL: https://www.alta.ru/tik/xml/?srchstr=зерно&login=testlogin&secret= | + | Добавляем хеш-строку и получаем итоговый URL: https://www.alta.ru/tik/xml/?srchstr=зерно&login=testlogin&secret=557272e59fce7d51f7d550301eb5753f |
| − | |||
| − | |||
Ниже приводится полный список входных параметров: | Ниже приводится полный список входных параметров: | ||
| Строка 46: | Строка 44: | ||
==Примеры запросов== | ==Примеры запросов== | ||
Подбор кодов по словосочетанию:<br> | Подбор кодов по словосочетанию:<br> | ||
| − | https://www.alta.ru/tik/xml/?srchstr=%D0%B7%D0%B5%D1%80%D0%BD%D0%BE&login=testlogin&secret= | + | https://www.alta.ru/tik/xml/?srchstr=%D0%B7%D0%B5%D1%80%D0%BD%D0%BE&login=testlogin&secret=557272e59fce7d51f7d550301eb5753f |
Дополнительные записи по словосочетанию и коду 1104291700:<br> | Дополнительные записи по словосочетанию и коду 1104291700:<br> | ||
| − | https://www.alta.ru/tik/xml/?tnfiltr=1104291700&srchstr=%D0%B7%D0%B5%D1%80%D0%BD%D0%BE&page=2&login=testlogin&secret= | + | https://www.alta.ru/tik/xml/?tnfiltr=1104291700&srchstr=%D0%B7%D0%B5%D1%80%D0%BD%D0%BE&page=2&login=testlogin&secret=557272e59fce7d51f7d550301eb5753f |
| Строка 84: | Строка 82: | ||
|- | |- | ||
|110||Лимит запросов для данного пользователя исчерпан | |110||Лимит запросов для данного пользователя исчерпан | ||
| + | |- | ||
| + | |120||Ошибка тарификации | ||
|- | |- | ||
|200||Строка поиска должна состоять из 3-х или более символов | |200||Строка поиска должна состоять из 3-х или более символов | ||
| Строка 97: | Строка 97: | ||
Лимит запросов для данного пользователя исчерпан:<br> | Лимит запросов для данного пользователя исчерпан:<br> | ||
| − | https://www.alta.ru/tik/xml/?srchstr=%D0%B7%D0%B5%D1%80%D0%BD%D0%BE&login=testloginlimit&secret= | + | https://www.alta.ru/tik/xml/?srchstr=%D0%B7%D0%B5%D1%80%D0%BD%D0%BE&login=testloginlimit&secret=ce3642297fe33bcb943829acf4cda884 |
| + | |||
| + | Строка поиска не должна быть слишком короткая:<br> | ||
| + | https://www.alta.ru/tik/xml/?srchstr=%D0%B7%D0%B5&login=testlogin&secret=ff5e9bec5d9f81665eb7920bee3a6a2f | ||
| + | |||
| + | По данному запросу информация не найдена:<br> | ||
| + | https://www.alta.ru/tik/xml/?srchstr=%D0%B7%D0%B5%D1%80%D0%BD%D0%BE%D0%B7%D0%B5%D1%80%D0%BD%D0%BE&login=testlogin&secret=1415376d0aae6e94875c43e1d8e79b7e | ||
| − | |||
| − | |||
Текущая версия на 19:07, 25 марта 2022
О сервисе
XML-API «Товары и коды» позволяет интегрировать возможности сервиса в сторонние программы и сайты.
По искомому слову или словосочетанию сервис выдает список кодов ТН ВЭД и 100 первых записей по каждому коду, имеющих данное вхождение.
При необходимости можно отдельно тарифицируемым запросом дозапросить следующие 100 записей определенного кода ТН ВЭД, содержащих искомое словосочетание.
API
Доступ к API предоставляется по URL https://www.alta.ru/tik/xml/. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.
Для авторизации с помощью пары логин/пароль необходимо в GET-запрос добавить логин в открытом виде и MD5-хеш от сгенерированной строки словосочетание + логин + пароль, разделенный знаком двоеточия «:», например для пользователя с логином testlogin и паролем testpassword:
Создаем запрос: https://www.alta.ru/tik/xml/?srchstr=зерно&login=testlogin
Вычисляем секрет: secret = md5("зерно:testlogin:md5(testpassword)")
Добавляем хеш-строку и получаем итоговый URL: https://www.alta.ru/tik/xml/?srchstr=зерно&login=testlogin&secret=557272e59fce7d51f7d550301eb5753f
Ниже приводится полный список входных параметров:
| Параметр | Тип | Описание |
|---|---|---|
| Обязательные | ||
| srchstr | string | Слово или словосочетание; от 3-х букв |
| Необязательные | ||
| login | string | Логин к сервису |
| secret | string | MD5-секрет для данного запроса |
| tncode | string | Код ТН ВЭД; от 2 до 10 цифр для ограничения поиска по подразделам, группам, подгруппам и т.п. |
| page | int | Номер страницы при дополнительном запросе данных по определенному коду; от 2 |
Примеры запросов
Подбор кодов по словосочетанию:
https://www.alta.ru/tik/xml/?srchstr=%D0%B7%D0%B5%D1%80%D0%BD%D0%BE&login=testlogin&secret=557272e59fce7d51f7d550301eb5753f
Дополнительные записи по словосочетанию и коду 1104291700:
https://www.alta.ru/tik/xml/?tnfiltr=1104291700&srchstr=%D0%B7%D0%B5%D1%80%D0%BD%D0%BE&page=2&login=testlogin&secret=557272e59fce7d51f7d550301eb5753f
XML-ответ
| TikList | Корневой элемент документа |
| Общая информация | |
| TikList->Code | Код ТН ВЭД |
| TikList->Count | Количество записей для данного кода |
| Записи для кода | |
| TikList->Notes | Список из записей |
| TikList->Notes->Note | Запись для кода |
Ошибки
При возникновении ошибки в корневом элементе появляется блок с кодом и описанием ошибки.
При работе с сервисом возможны следующие ошибки:
| Код | Описание |
|---|---|
| 100 | Пользователь не авторизирован |
| 110 | Лимит запросов для данного пользователя исчерпан |
| 120 | Ошибка тарификации |
| 200 | Строка поиска должна состоять из 3-х или более символов |
| 210 | По данному запросу информация не найдена |
Примеры ошибок
Пользователь не авторизирован:
https://www.alta.ru/tik/xml/?srchstr=test
Лимит запросов для данного пользователя исчерпан:
https://www.alta.ru/tik/xml/?srchstr=%D0%B7%D0%B5%D1%80%D0%BD%D0%BE&login=testloginlimit&secret=ce3642297fe33bcb943829acf4cda884
Строка поиска не должна быть слишком короткая:
https://www.alta.ru/tik/xml/?srchstr=%D0%B7%D0%B5&login=testlogin&secret=ff5e9bec5d9f81665eb7920bee3a6a2f
По данному запросу информация не найдена:
https://www.alta.ru/tik/xml/?srchstr=%D0%B7%D0%B5%D1%80%D0%BD%D0%BE%D0%B7%D0%B5%D1%80%D0%BD%D0%BE&login=testlogin&secret=1415376d0aae6e94875c43e1d8e79b7e
