API для сервиса report.alta.ru: различия между версиями

Материал из Alta-Soft Wikipedia
Перейти к навигации Перейти к поиску
м (→‎Получение документов)
м (→‎Получение документов)
Строка 90: Строка 90:
 
!Параметр || '''Тип''' || Описание || Пример
 
!Параметр || '''Тип''' || Описание || Пример
 
|-
 
|-
−
|regdate[from] || string || дата регистрации от<br/>только дата || regdate[from]=2019-03-01
+
|regdate[from] || '''string''' || дата регистрации от<br/>только дата || regdate[from]=2019-03-01
 
|-
 
|-
−
|regdate[to] || string || дата регистрации до<br/>только дата || regdate[to]=2019-03-01
+
|regdate[to] || '''string''' || дата регистрации до<br/>только дата || regdate[to]=2019-03-01
 
|-
 
|-
−
|vypdate[from] || string || ДатаВремя выпуска от || vypdate[from]=2019-05-08<br/>vypdate[from]=2021-10-10Т10:30:00
+
|vypdate[from] || '''string''' || ДатаВремя выпуска от || vypdate[from]=2019-05-08<br/>vypdate[from]=2021-10-10Т10:30:00
 
|-
 
|-
−
|vypdate[to] || string || ДатаВремя выпуска до || vypdate[to]=2019-05-08<br/>vypdate[to]=2021-10-20Т10:30:00+03:00
+
|vypdate[to] || '''string''' || ДатаВремя выпуска до || vypdate[to]=2019-05-08<br/>vypdate[to]=2021-10-20Т10:30:00+03:00
 
|-
 
|-
−
|lastmsgdate[from] || string || последнее сообщение ДатаВремя от || lastmsgdate[from]= 2019-05-08<br/>lastmsgdate[from]=2021-10-10Т10:30:00
+
|lastmsgdate[from] || '''string''' || последнее сообщение ДатаВремя от || lastmsgdate[from]= 2019-05-08<br/>lastmsgdate[from]=2021-10-10Т10:30:00
 
|-
 
|-
−
|lastmsgdate[to] || string || последнее сообщение ДатаВремя до || lastmsgdate[to]=2019-03-01<br/>lastmsgdate[to]=2021-10-20Т10:30:00+03:00
+
|lastmsgdate[to] || '''string''' || последнее сообщение ДатаВремя до || lastmsgdate[to]=2019-03-01<br/>lastmsgdate[to]=2021-10-20Т10:30:00+03:00
 
|-
 
|-
−
|decl || array || ИНН декларанта, можно несколько || decl[]=555555<br/>decl[]=666666
+
|decl || '''array''' || ИНН декларанта, можно несколько || decl[]=555555<br/>decl[]=666666
 
|-
 
|-
−
|tam || array || Номер таможенного поста, можно несколько || tam[]=555
+
|tam || '''array''' || Номер таможенного поста, можно несколько || tam[]=555
 
|-
 
|-
−
|login || array || Логин, можно несколько || login[]=xxx
+
|login || '''array''' || Логин, можно несколько || login[]=xxx
 
|-
 
|-
−
|pid || array || процедуры || pid[]=xxx&pid[]=yyy&pid[]=zzz&..
+
|pid || '''array''' || процедуры || pid[]=xxx&pid[]=yyy&pid[]=zzz&..
 
|}
 
|}
  
 
В ответ получаем документы
 
В ответ получаем документы
 +
 +
{| class="wikitable"
 +
|docs || '''array''' || массив документов ||
 +
|}
 +
 +
из выдачи убрали заголовки столбцов, для их получения есть запрос апи <code>/docs/fields/</code>
 +
 +
==== Массив docs ====
 +
 +
Это массив документов, содержит в себе объект doc
 +
 +
==== Объект doc ====
 +
 +
{| class="wikitable"
 +
!messagetype || '''string''' || Тип текущего сообщения с ДТ || CMN.11023
 +
|-
 +
|login || '''string''' || Логин || 123456
 +
|-
 +
|envelopeid || '''string''' || EnvelopeID текущего сообщения с ДТ || BD9D1189-A58E-482B-A108-ADF7D2459BFD
 +
|-
 +
|status || '''string''' || Статус процедуры в числовом виде || 3
 +
|-
 +
|softver || '''string''' || Версия альбома и спецификации || 5.14.2/3.3.21
 +
|-
 +
|ProccessID || '''string''' || ID процедуры || 1a2ab345-1a12-1a01-1234-1234a5678bc1
 +
|-
 +
|LastMessageDate || '''string''' || Дата последнего сообщения по процедуре  ||
 +
|-
 +
|DeclarantOrganizationName || '''string''' || Наименование организациии || ООО \"Альта-Софт\"
 +
|-
 +
|DeclarantINN || '''string''' || ИНН декларанта || 1234567890
 +
|-
 +
|DeclarantOGRN || '''string''' || ОГРН декларанта ||
 +
|-
 +
|DeclarantFIO || '''string''' || ФИО декларанта из гр.54 ||
 +
|-
 +
|consignorName || '''string''' || Отправитель ||
 +
|-
 +
|consignorAddres || '''string''' || Адрес отправителя ||
 +
|-
 +
|consigneeName || '''string''' || Получатель ||
 +
|-
 +
|consigneeAddres || '''string''' || Адрес получателя ||
 +
|-
 +
|Transp || '''string''' || Номера транспортных средств ||
 +
|-
 +
|TrDoc || '''string''' || Номер транспортных документов ||
 +
|-
 +
|Cont || '''string''' || Номера контейнеров
 +
|-
 +
|NetWeightQuantity || '''string''' || Нетто || 20160.00
 +
|-
 +
|GrossWeightQuantity || '''string''' || Брутто || 20640.00
 +
|-
 +
|CustomsCost || '''string''' || Таможенная стоимость || 1989792.00
 +
|-
 +
|InvoicedCost || '''string''' || Фактурная стоимость || 1989792.00
 +
|-
 +
|ContractCurrencyCode || '''string''' || Валюта контракта || RUB
 +
|-
 +
|REGNUM || '''string''' || Номер ДТ || 10000000/010121/0123456
 +
|-
 +
|PackageNumber || '''string''' || Кол-во мест ||
 +
|-
 +
|GoodsCount || '''string''' || Кол-во товаров || 1
 +
|-
 +
|UD || '''string''' || Код поста гр.30 ||
 +
|-
 +
|CustomsProcedure || '''string''' || Режим || ИМ
 +
|-
 +
|CustomsModeCode || '''string''' || Процедура || 40
 +
|-
 +
|DeclarationKind || '''string''' || Особенности процедуры || ПТД
 +
|}

Версия 11:54, 11 августа 2022

Сервис мониторинг таможенного оформления (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&..

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

docs array массив документов

из выдачи убрали заголовки столбцов, для их получения есть запрос апи /docs/fields/

Массив docs

Это массив документов, содержит в себе объект doc

Объект doc

messagetype string Тип текущего сообщения с ДТ CMN.11023
login string Логин 123456
envelopeid string EnvelopeID текущего сообщения с ДТ BD9D1189-A58E-482B-A108-ADF7D2459BFD
status string Статус процедуры в числовом виде 3
softver string Версия альбома и спецификации 5.14.2/3.3.21
ProccessID string ID процедуры 1a2ab345-1a12-1a01-1234-1234a5678bc1
LastMessageDate string Дата последнего сообщения по процедуре
DeclarantOrganizationName string Наименование организациии ООО \"Альта-Софт\"
DeclarantINN string ИНН декларанта 1234567890
DeclarantOGRN string ОГРН декларанта
DeclarantFIO string ФИО декларанта из гр.54
consignorName string Отправитель
consignorAddres string Адрес отправителя
consigneeName string Получатель
consigneeAddres string Адрес получателя
Transp string Номера транспортных средств
TrDoc string Номер транспортных документов
Cont string Номера контейнеров
NetWeightQuantity string Нетто 20160.00
GrossWeightQuantity string Брутто 20640.00
CustomsCost string Таможенная стоимость 1989792.00
InvoicedCost string Фактурная стоимость 1989792.00
ContractCurrencyCode string Валюта контракта RUB
REGNUM string Номер ДТ 10000000/010121/0123456
PackageNumber string Кол-во мест
GoodsCount string Кол-во товаров 1
UD string Код поста гр.30
CustomsProcedure string Режим ИМ
CustomsModeCode string Процедура 40
DeclarationKind string Особенности процедуры ПТД
Источник — https://wiki.alta.ru/index.php?title=API_для_сервиса_report.alta.ru&oldid=1237