API для сервиса report.alta.ru

Сервис мониторинг таможенного оформления (REPORT ALTA)

Сервис предоставляет разработчикам возможность получения информации из внешних программ и сайтов в JSON-формате. С помощью данного сервиса можно выгружать следующую информацию:

1. Список логинов, к пользователю может быть прикреплено много логинов
2. Декларанты, таможенные посты
3. Получение ДТ
4. Получение документов гр.44 (если включено дублирование всех сообщений)
5. Получение ЭД сообщений

Описание параметров

Доступ к API предоставляется по URL https://report.alta.ru/api/ Входные параметры передаются с помощью запроса HTTPS GET. Для использования сервиса необходимо получить apikey и secret в личном кабинете

Пример адреса запроса с параметрами: https://report.alta.ru/api/function/параметр0/?параметр1…2...параметрN&apikey=XXXX&hash=YYYYY

любой запрос должен содержать обязательные параметры, они выделены жирным

Параметр	Тип	Описание	Пример
Обязательные, должны быть в любом запросе
v1	string	Версия апи, текущая версия 1	v1 v2 … v1.1
function	string	вызываемая функция апи	docs, decl, logins, tam
apikey	string	Ключ авторизации, получить в личном кабинете	5b145adecf42b8eecd4e6f3dc7134f45
hash	string	ХЭШ запроса, рассчитывается для каждого запроса по слову secret	34563456

К необязательным параметрам относится, например, параметр0 Параметр0 идет сразу после функции, его можно опустить, и не писать, тогда ставим слеш после функции и дописываем обязательные параметры ключ и хэш, пример:

/api/v1/docs/?apikey=XXX&hash=YYY

Параметр0 указываем для получения конкретного документа, пример:

/api/v1/docs/xxxxx/?apikey=XXX&hash=YYY

секрет нужен для генерации хэша (подписи) запроса, ХЭШ генерируется так:

hash = md5(версия + функция + параметр0(если есть) + ВСЕ_ПАРАМЕТРЫ + md5(apikey) + md5(secret)) ВСЕ_ПАРАМЕТРЫ — это конкатенация всех GET параметров в той последовательности, в которой они идут в параметрах запроса слева направо, параметры: апи ключ, хеш и секрет не участвуют пример, запрос:

https://report.alta.ru/api/v1/docs/?x=1&y=2&z=3&apikey=5555&hash=5b145adecf42b8eecd4e6f3dc7134f45

в данном случае ВСЕ_ПАРАМЕТРЫ это x y z нам известно, что наш аккаунт имеет следующие данные: apikey = 5555, secret = 7777 тогда вычислим хэш:

hash = md5 ( 1 + docs + (параметр0 не указан, его не берем) + 1 + 2 + 3 + md5(5555) + md5(7777)) = md5 (1docs1236074c6aa3488f3c2dddff2a7ca821aabd79c8788088c2193f0244d8f1f36d2db ) = получилось, что hash = 5b145adecf42b8eecd4e6f3dc7134f45

Список всех функций API

Для наглядности опустим тут обязательную часть запроса, оставим только конкретику

https://report.alta.ru/api/v1/FUNC/param0/?apikey=XXX&hash=YYY

Получение логинов

/logins/

Ответом получаем массив с логинами

Получение декларантов

/decl/

получаем массив с ИНН и названиями организаций

Получение таможенных постов

/tam/

Получаем массив таможенных постов

Получение документов

/docs/

фильтры, передаются как ПАРАМЕТРЫ запроса, пример:

https://report.alta.ru/api/v1/docs/?regdate[from]=2019-03-01&apikey=xxx&hash=xxx&

Параметр	Тип	Описание	Пример
regdate[from]	string	дата регистрации от только дата	regdate[from]=2019-03-01
regdate[to]	string	дата регистрации до только дата	regdate[to]=2019-03-01
vypdate[from]	string	ДатаВремя выпуска от	vypdate[from]=2019-05-08 vypdate[from]=2021-10-10Т10:30:00
vypdate[to]	string	ДатаВремя выпуска до	vypdate[to]=2019-05-08 vypdate[to]=2021-10-20Т10:30:00+03:00
lastmsgdate[from]	string	последнее сообщение ДатаВремя от	lastmsgdate[from]= 2019-05-08 lastmsgdate[from]=2021-10-10Т10:30:00
lastmsgdate[to]	string	последнее сообщение ДатаВремя до	lastmsgdate[to]=2019-03-01 lastmsgdate[to]=2021-10-20Т10:30:00+03:00
decl	array	ИНН декларанта, можно несколько	decl[]=555555 decl[]=666666
tam	array	Номер таможенного поста, можно несколько	tam[]=555
login	array	Логин, можно несколько	login[]=xxx
pid	array	процедуры	pid[]=xxx&pid[]=yyy&pid[]=zzz&..

В ответ получаем документы