API онлайн-сервиса Товары и Коды

Материал из Alta-Soft Wikipedia
Версия от 19:07, 23 ноября 2017; Krashennikova (обсуждение | вклад) (Новая страница: «==О сервисе== XML-API «Товары и коды» позволяет интегрировать возможности сервиса в сторонни…»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к навигации Перейти к поиску

О сервисе

XML-API «Товары и коды» позволяет интегрировать возможности сервиса в сторонние программы и сайты.

По искомому слову или словосочетанию сервис выдает список кодов ТН ВЭД и 100 первых записей по каждому коду, имеющих данное вхождение.

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

API

Доступ к API предоставляется по URL https://www.alta.ru/tik/xml/. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью логина и пароля, либо доступ может быть предоставлен по статичному IP-адресу.

Для авторизации с помощью пары логин/пароль необходимо в GET-запрос добавить логин в открытом виде и MD5-хеш от сгенерированной строки словосочетание + логин + пароль, разделенный знаком двоеточия «:», например для пользователя с логином testlogin и паролем testpassword:
Создаем запрос: https://www.alta.ru/tik/xml/?srchstr=зерно&login=testlogin Вычисляем секрет: secret = md5("зерно:testlogin:testpassword") Добавляем хеш-строку и получаем итоговый URL: https://www.alta.ru/tik/xml/?srchstr=зерно&login=testlogin&secret=3d39b0be0a5e5bb7fc071261c4a68c03

Для авторизации по статическому IP-адресу никакой дополнительной информации, кроме запроса, передавать не нужно. Запрос будет выглядеть как https://www.alta.ru/tik/xml/?srchstr=зерно

Ниже приводится полный список входных параметров:

Параметр Тип Описание
Обязательные
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=3d39b0be0a5e5bb7fc071261c4a68c03

Дополнительные записи по словосочетанию и коду 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=3d39b0be0a5e5bb7fc071261c4a68c03


XML-ответ

TikList Корневой элемент документа
Общая информация
TikList->Code Код ТН ВЭД
TikList->Count Количество записей для данного кода
Записи для кода
TikList->Notes Список из записей
TikList->Notes->Note Запись для кода


Ошибки

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

Код Описание
100 Пользователь не авторизирован
110 Лимит запросов для данного пользователя исчерпан
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=42f74ba279764e904b852acb6ce8d6cd

Строка поиска не должна бытьслишком короткая:
https://www.alta.ru/tik/xml/?srchstr=%D0%B7%D0%B5&login=testlogin&secret=5ad700cde63055c423288c3d624dc7c0