Alta-Soft Wikipedia - Вклад участника [ru]

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

2026-09-24T17:15:05Z

Ivakin: /* простой клиент на питоне убрал verify */

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

# Список логинов, к пользователю может быть прикреплено много логинов
# Декларанты, таможенные посты
# Получение ДТ, ТД, Пассажирских ТД, Заявлений о выпуске до подачи
# Получение привязанных документов (если включено дублирование всех сообщений)
# Получение ЭД сообщений

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

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

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

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

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

<code>/api/v1/docs/?apikey=XXX&hash=YYY</code>

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

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

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

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

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

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

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

== Список всех функций API ==
Для наглядности опустим тут обязательную часть запроса, оставим только конкретику

<code><nowiki>https://report.alta.ru/api/v1</nowiki>/'''FUNC/param0'''/?apikey=XXX&hash=YYY</code>

=== Получение логинов ===
<code>/logins/</code>

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

=== Получение декларантов ===
<code>/decl/</code>

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

=== Получение таможенных постов ===
<code>/tam/</code>

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

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

<code>/docs/types/</code>

{| class="wikitable"
!Параметр || Описание || Пример
|-
|title || Краткое наименование документа || ДТ
|-
|toolTip || Полное наименование документа || Декларация на товары
|-
|maxDatePeriod || Максимальное кол-во месяцев в периоде, за который можно запрашивать документы || 3
|-
|filters || Список возможных фильтров для запроса списка документов ||
|}

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

<code>/docs/</code>

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

<code><nowiki>https://report.alta.ru/api/v1/docs</nowiki>/?'''doctype=gtd&regdate[from]=2019-03-01'''&apikey=xxx&hash=xxx&</code>

{| class="wikitable"
!Параметр || '''Тип''' || Описание || Пример
|-
|'''doctype''' || '''string''' || Вид документа (gtd, td1, arg, passd) || doctype=gtd (по умолчанию, можно не указывать)
|-
|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-10T10:30:00
|-
|vypdate[to] || '''string''' || ДатаВремя выпуска до || vypdate[to]=2019-05-08 vypdate[to]=2021-10-20T10:30:00+03:00
|-
|lastmsgdate[from] || '''string''' || последнее сообщение ДатаВремя от || lastmsgdate[from]= 2019-05-08 lastmsgdate[from]=2021-10-10T10:30:00
|-
|lastmsgdate[to] || '''string''' || последнее сообщение ДатаВремя до || lastmsgdate[to]=2019-03-01 lastmsgdate[to]=2021-10-20T10: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&..
|-
|cmn || '''array''' || Тип ЭД сообщения, можно несколько || cmn[]=CMN.11005 cmn[]=CMN.11252
|}

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

{| class="wikitable"
|docs || '''array''' || массив документов ||
|}

==== Массив docs ====

Это массив документов, содержит в себе объект doc
Список столбцов с их описанием и примерами можно получить отдельным запросом апи <code>/docs/fields/</code>

==== Получение, Печать документа, Просмотр документа ====

Теперь, зная список документов, можно получить определенный документ по его ID, вывод данного запроса по умолчанию идет в html виде

<code>/docs/ID/</code>

, где ID = ProccessID_Login, пример: <code>1a2ab345-1a12-1a01-1234-1234a5678bc1_123456</code>

'''также можно передать дополнительные параметры'''

{| class="wikitable"
!Параметр || '''Тип''' || Описание || Пример
|-
|format || '''string''' || Формат ответа (html, xml, pdf) || format=xml
|}

==== Получение полей (заголовки столбцов) ====

<code>/docs/fields/</code>

получение полей, заголовков столбцов с их описанием и примерами

==== Получение списка привязанных ЭД документов ====

<code>/docs44/ID/</code>

, где ID = ProccessID_Login, пример: 1a2ab345-1a12-1a01-1234-1234a5678bc1_123456

'''также можно передать дополнительные параметры - фильтры'''

у каждого документа, есть вложенные документы, у документа может быть очень много записей в этом параметре,
поэтому также есть фильтр по вложенным документам

{| class="wikitable"
!Параметр || '''Тип''' || Описание || Пример
|-
|docCode || '''string''' || Код документа, можно указать часть кода , но только от начала строки || 0234*, 04031
|-
|docNum || '''string''' || Номер документа, можно указать любую часть номера без звездочек VN-RU || VN-RU, 18/04/
|-
|docDate[from] || '''string''' || Дата от || 2018-01-01
|-
|docDate[to] || '''string''' || Дата до || 2019-05-08
|-
|tovNum[] || '''array''' || Номер товара, задается массивом || tovNum[]=1tovNum[]=40
|}

в ответ получаем массив с документами

{| class="wikitable"
|docName || '''string''' || имя документа
|-
|docCode || '''string''' || Код документа
|-
|docDate || '''string''' || Дата документа
|-
|tovNum || '''string''' || Товары, их номера
|-
|elDocId || '''string''' || ID документа в архиве таможни
|-
|docNum || '''string''' || Номер документа
|-
|elArchId || '''string''' || ID архива таможни
|}

==== Получение привязанного ЭД документа ====

Запрос похож на предыдущий, добавляем только ID документа в архиве таможни

<code>/docs44/ID/</code>

, где ID = elDocId_ProccessID_Login, пример: b1b2abcd-1a2b-1a23-a123-a12b345cde1a_1a2ab345-1a12-1a01-1234-1234a5678bc1_123456

=== Получение сообщений ===

<code>/messages/ID/</code>

, где ID = ProccessID_Login, пример: 1a2ab345-1a12-1a01-1234-1234a5678bc1_123456

ProccessID и Login обязательны

дополнительные параметры для запроса:

{| class="wikitable"
!Параметр || '''Тип''' || Описание || Пример
|-
|date[from] || '''string''' || Дата сообщения от || date[from]=2019-03-01
|-
|date[to] || '''string''' || Дата сообщения до || date[to]=2019-03-01
|}

==== Массив messages ====

в ответ получаем объект messages, это массив с элементами message - объект с данными сообщения

{| class="wikitable"
|messages || array || массив с сообщениями
|}

сообщение message, элемент этого массива, структура:

{| class="wikitable"
|messagetype|| '''string''' || Тип сообщения || CMN.11001
|-
|messagename || '''string''' || Наименование сообщения || Регистрационный номер ДТ
|-
|priority || '''string''' || Служебное поле в заголовке сообщения || 4
|-
|incoming || '''string''' || 0 - исходящее сообщение, 1 - входящее || 1
|-
|login || '''string''' || Логин || 123456-ca
|-
|svdlogin || '''string''' || Логин, с которого пришло сообщение || 123456-01
|-
|envelopeid || '''string''' || EnvelopeID сообщения || BD9D1189-A58E-482B-A108-ADF7D2459BFD
|-
|softversion || '''string''' || Версия альбома и спецификации || 5.14.2/3.3.21
|-
|participantid || '''string''' || ID декларанта
|-
|customscode || '''string''' || Код таможни сообщения ||
|-
|initialenvelopeid || '''string''' || EnvelopeID родительского сообщения (на которое ссылается данное сообщение) ||
|-
|preparationdatetime || '''string''' || Дата и время сообщения ||
|-
|exchtype || '''string''' || Служебное поле в заголовке сообщения || 19200
|-
|proccessid || '''string''' || ID процедуры сообщения || 1a2ab345-1a12-1a01-1234-1234a5678bc1
|-
|mainproccessid || '''string''' || ID основной процедуры (если есть) || 1a2ab345-1a12-1a01-1234-1234a5678bc1
|-
|senderinformation || '''string''' || Отправитель сообщения || smtp://eps.customs.ru/gateway
|-
|receiverinformation || '''string''' || Получатель сообщения || smtp://eps.customs.ru/102770123456789.as
|-
|sign || '''string''' || Электронная подпись || ФЕДЕРАЛЬНАЯ ТАМОЖЕННАЯ СЛУЖБА
|-
|canView || '''string''' || 1 – возможен ли просмотр сообщения ||
|-
|type || '''string''' || arch – документ из архива (возможен запрос документа по ArchDocID) ||
|-
|archid || '''string''' || ID архива таможни ||
|-
|archdocid || '''string''' || ID документа в архиве таможни ||
|-
|objects|| '''array''' || массив xml-объектов, содержащихся в данном сообщении (в т.ч. дата из поля DateLimit, если есть указан срок ответа) ||
|}

==== Получение сообщения ====

Запрос похож на предыдущий, добавляется только EnvelopeID

<code>/messages/ID/</code>

, где ID = EnvelopeID_ProccessID_Login, пример: b1b2abcd-1a2b-1a23-a123-a12b345cde1a_1a2ab345-1a12-1a01-1234-1234a5678bc1_123456

EnvelopeID, ProccessID и Login обязательны

возвращается сообщение по умолчанию в html виде

если сообщение содержит несколько документов, то все они будут склеены в один html

НО разделены комментариями <nowiki> </nowiki>

лучше показывать каждый документ отдельно, т.к. иногда бывает, что у документов пересекаются стили и они могут выглядеть некорректно, т.к. при склеивании html склеивается тело и стили. Пример как это выглядит:

<source lang="xml">



<!DOCTYPE html ....
html.... тело документа со всеми стилями


<!DOCTYPE html ....
html.... тут следующее тело со стилями
</source>

надо ориентироваться, если в начале документа есть параметр count 2, то значит в сообщении 2 документа

'''также можно передать дополнительные параметры'''

{| class="wikitable"
!Параметр || '''Тип''' || Описание || Пример
|-
|format || '''string''' || Формат ответа (html, xml, pdf) || format=xml
|}

== Типы данных ==

{| class="wikitable"
|'''string''' || строковый параметр
|-
|'''array''' || массив значений, нумерация элементов начинается с 0, вложенные элементы могут быть всех типов
|-
|'''object''' || объект значений или именованный массив. ключи - могут быть как числовые так и текстовые, вложенные элементы могут быть всех типов
|}

== Ошибки ==

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

{| class="wikitable"
!Код || Описание
|-
|'''100''' || Нет обязательных параметров
|-
|'''200''' || АПИ ключ не найден или не действительный
|-
|'''201''' || Неверный хэш
|-
|'''202''' || Ошибка авторизации, обратитесь к администратору
|-
|'''204''' || Нет права выполнять эту операцию(запрос)
|-
|'''203''' || Слишком много запросов. Запрос отклонен
|-
|'''210''' || Необходимо принять оферту на сайте
|-
|'''300''' || Метод API не найден, возможно неверная версия АПИ
|-
|'''301''' || В запросе(методе) отсутствует необходимый параметр
|-
| || Строка запроса содержит синтаксическую ошибку
|-
|'''500''' || Обработка запроса потерпела неудачу из-за неизвестной ошибки, исключения
|}

пример ошибок

<source lang='json'>
{
"error": 200,
"text": "BAD api key, USER not found"
}
{
"error": 201,
"text": "ERROR HASH"
}
{
"error": 203,
"q": "v1/decl/",
"request_wait": 3.05,
"text": "Sory, You have Limit requests to API: 5 requests per 10 seconds. Please wait 3.05 sec for next request"
}
</source>

== Примеры реализации простого клиента ==

=== простой клиент на питоне ===

на питоне 2.7, надо установить библиотеку pip install requests

<source lang="Python">
apikey = "api_key" # ваш ключ апи
secret = "secret" # ваш секрет апи
v = 1 # версия
func = "docs" # вызываемая функция
param = "" # параметр используется для получения конкретного документа, например /docs/ID/ /docs/100000000/
# доп параметры запроса
params = {
'd': '123',
'param1': 'xxxxx',
'param2': 'yyyyyy'
}
# урл для запроса
api_url = "https://report.alta.ru/api/v%d/%s/" % (v, func) + (param + "/" if param else "")

if __name__ == "__main__":
# рассчитываем хэш секрет для запроса
# идем по всем параметрам по порядку
str = ""
for p in params:
str += params[p]
print p, params[p]
# и в конце прибавляем ключ
str = "%d%s%s%s%s" % (v, func + (param if param else ""), str, hashlib.md5(apikey).hexdigest(), hashlib.md5(secret).hexdigest())
# считаем хэш
hash = hashlib.md5(str).hexdigest()
# добавляем эти параметры в запрос
params['hash'] = hash # + "1111"
params['apikey'] = apikey
print str, hash, api_url
# делаем запрос
r = requests.get(api_url, params)
# выдаем ответ
if r.status_code != 200:
print r.status_code, "Похоже возникли ошибки: \n", r.text, r.json()
else:
print "ОТВЕТ", r.text, r.json()
</source>

[[Категория:Автоматизация]]

API Слежение (для Груз на СВХ)

2024-11-13T09:14:44Z

Ivakin:

== О сервисе Слежение ==
Сервис "Слежение" для "Груз на СВХ" <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki> позволяет ставить контейнеры и авианакладные на слежение с получением результатов размещения на складе и таможенного оформления грузов в контейнере через личный кабинет.

Отправляет уведомления на почту и URL-адрес по webhook о появлении новой информации по указанным контейнерам. Ставить и снимать контейнеры со слежения можно как через личный кабинет так и по API. Почта, URL-адрес для уведомлений и события для уведомления настраиваются только через личный кабинет.

== API ==
Доступ к API предоставляется по URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki>. Для использования сервиса необходима авторизация с помощью логина и пароля.

Логин и пароль для обращения по API необходимо получить в личном кабинете <nowiki>https://www.alta.ru/user/</nowiki>, заключив договор на использование онлайн-сервисов. В настройках договора будут указаны технический логин и пароль.

Тарификация производится так же как при постановке на слежение через личный кабинет.

API позволяет ставить, снимать со слежения и просматривать списки контейнеров и авианакладных находящихся на слежении. Уведомления об обнаружении новой информации приходят на указанные почтовые ящики в кабинете слежения <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki>

=== Формирование URL запроса ===
Запросы направляются на URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki><МЕТОД>/
{| class="wikitable"
|Метод
|Тип запроса
|Описание
|-
|help
|GET
|Вызывает справку - выдает доступные методы API и списки передаваемых параметров
|-
|test
|GET
|Проверка работы API и правильности формирования запроса - выдает результат проверки правильности секрета, правильную строку для расчета секрета и логин (если отправлен верный секрет)
|-
|info
|GET
|Информация об аккаунте и настройках слежения
|-
|set
|POST
|Постановка контейнеров на слежение, POST-параметр data=<номера контейнеров / авианакладных через запятую “,”>
|-
|del
|POST
|Снятие контейнеров со слежения, POST-параметр ids=<id контейнеров / авианакладных через запятую “,”> или data=<имена контейнеров / авианакладных через запятую “,”> (id контейнера приходит при постановке на слежение)
|-
|list
|GET
|Просмотр статуса всех отслеживаемых контейнеров. Через этот метод можно узнать id контейнеров находящихся на слежении. Можно указать нужные контейнеры: ids=<id контейнеров через запятую “,”> или data=<имена контейнеров через запятую “,”>
|}
обязательные GET параметры в URL

# логин ― логин сервис аккаунта в открытом виде
# секрет ― MD5-хеш от сгенерированной строки (все параметры разделены знаком “:” (двоеточие)): параметры_GET + параметры_POST + метод + логин + md5(пароль)

Формирование секрета

secret = md5("{параметры_GET}:{параметры_POST}:{метод}:{логин}:{md5(пароль)}")

параметры_GET ― это значения прочих get параметров помимо логина, секрета и метода, разделенные “:”

параметры_POST ― это значения post параметров для методов set и del, разделенные “:”

Пример расчёта секрета для метода del, логина testlogin и пароля testpassword:

Если дополнительный GET параметр foo = bar , то для расчета секрета надо использовать параметры_GET = “bar”

Для метода del надо указывать id номера контейнеров в POST параметре ids через запятую. Если ids=11,55,33 , то для расчета секрета параметры_POST = “11,55,33”

Итоговая строка секрета = md5("bar:11,55,33:del:testlogin:md5(testpassword)")

Пример запроса списка контейнеров:

Метод list, пользователь с логином testlogin и пароль testpassword

Прочие параметры_GET - отсутствуют, параметры_POST отсутствуют, так как это GET метод

Вычисляем секрет: secret = md5("пусто:пусто:list:testlogin:md5(testpassword)") = md5("::list:testlogin:md5(testpassword)") = 18a3a18768475d5fbaf244f291212e86

Таким образом, итоговый URL, на который совершается GET-запрос: <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/list/?login=testlogin&secret=18a3a18768475d5fbaf244f291212e86</nowiki>

=== Ответ ===

<big>Метод</big> '''<big>List</big>'''
Описание полей возвращаемых данных
{| class="wikitable"
|data
|[]
|Корневой элемент, содержит массив записей слежения *
|-
|id
|int
|Идентификатор записи слежения
|-
|created
|str
|Дата постановки на слежение 3
|-
|updated
|str
|Дата последнего обновления информации сервисом
|-
|num
|str
|Номер контейнера или авианакладной
|-
|type
|str
|Тип слежения: К - контейнер, А - авианакладная
|-
|status
|str
|Статус слежения 1
|-
|do1
|int
|Количество записей ДО1 по контейнеру
|-
|cmn13014
|int
|Количество сообщений 13014 по контейнеру
|-
|infoDateMax
|str
|Дата последних полученных данных по контейнеру
|}
<nowiki>*</nowiki> максимальный размер возвращаемых данных 9900 записей

1 Статусы слежения:
{| class="wikitable"
|new
|Новый, запись только что добавлена
|-
|process
|В процессе обработки, проходят проверки
|-
|old
|В процессе обработки, имеется старая информация, старше чем указано в настройках ЛК в параметре Уведомлять о старой информации 2
|-
|busy
|Занят, происходит запись информации
|-
|arh
|Контейнер перенесен в архив (удален), автоматически помещается в архив если статус old более 90 дней
|}

2 Уведомлять о старой информации ― Параметр включает уведомления по событиям слежения с даты ранее даты постановки на слежение created 3

Например, если в параметре установлено 3 дня, то при постановке контейнера на слежение он уведомит Вас об информации, которая появилась не старше чем 3 дня назад.

<big>Пример ответа:</big>

Код ответа 200:

{

"data": [

{

"id": 12,

"created": "2023-01-19 12:03:45",

"updated": "2023-04-11 18:11:06",

"num": "XXXX1018593",

"status": "process",

"do1": 0,

"cmn13014": 0,

"infoDateMax": null,

},

...

]

}

<big>Метод</big> '''<big>Set</big>'''

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|-
|add
|[]
|Массив успешно добавленных контейнеров
|-
|no
|[]
|Массив контейнеров, которые не добавлены. Каждый элемент содержит массив, состоящий из номера контейнера и статуса
|}

<big>Пример ответа:</big>

{

"add": ["TEST0000001"],

"success": true,

"no": [

[ "TEST0000002", "Новый" ]

]

}

<big>Метод</big> '''<big>Del</big>'''
аналогичен методу set

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|}

<big>Пример ответа:</big>

{

"success": true

}

<big>Метод</big> '''<big>Info</big>'''
Описание полей возвращаемых данных

{| class="wikitable"
|success
|bol
|true ― успешный запрос
|-
|data
|[]
|Массив, содержащий настройки аккаунта
|-
|notifyEmail
|bool
|1 ― включены уведомления на email
|-
|notifyOneMail
|bool
|1 ― отдельное письмо для каждого результата. Если в течении минуты пришло несколько контейнеров, то при значении "0" они будут объединены в одно письмо
|-
|notifyTG
|bool
|1 ― включены уведомления в телеграмм
|-
|notifyWebhook
|bool
|1 ― включены уведомления webhook
|-
|webhook
|str
|URL-адрес webhook
|-
|tgId
|int
|ID привязанного телеграмм аккаунта
|-
|sa_balance
|float
|Баланс сервис аккаунта
|-
|service_price
|float
|Цена за уведомление
|-
|freezing
|float
|Заморожено средств
|-
|addArh
|bool
|Разрешено добавлять архивные
|-
|sa_login
|str
|Логин выбранного сервис аккаунта
|-
|notifyAddDoc
|bool
|1 ― добавляет номер документа-основания (ДО1 или CMN.13014) в текст уведомления
|-
|notifyOldDay
|int
|Кол-во дней. При постановке задачи на слежение учитывается полученная ранее информация. Если параметр = 3 дня, то будет уведомление об информации не старше 3 дней. Влияет только на начало слежения
|-
|notifyLoginEmail
|bool
|Уведомление на email аккаунта
|-
|notify13014
|bool
|Уведомлять о получении сообщений 13014
|-
|notifyDO1
|bool
|Уведомлять о появлении новых ДО1
|-
|login
|str
|Ваш логин
|-
|emails
|[]
|Массив Ваших дополнительных email адресов для уведомлений. Содержит массив значений ― email адрес (ключевое поле) и состояние - включен (true) или нет (false)
|}

<big>Пример ответа:</big>

{

"data": {

"notifyEmail": 0,

"service_price": 1,

"notifyAddDoc": 1,

"notifyTG": 0,

"freezing": 147,

"notifyWebhook": 0,

"webhook": null,

"addArh": 0,

"sa_login": "сервис аккаунт",

"notifyDO1": 0,

"tgId": 11122233344,

"sa_balance": 500,

"notifyOldDay": 3,

"notifyLoginEmail": 0,

"notify13014": 1,

"notifyOneMail": 0,

"login": "ваш логин",

"emails": {

"первый@": false,

"второй@": true

},

},

"success": true

}

=== Возможные ошибки ===
При возникновении ошибок возвращается код ответа сервера отличный от '''200''', а также описание ошибки в JSON-массиве.

код ответа '''400''':

{"success":false,"info":"Нет авторизации","code":101}

=== Webhook ===

По Webhook на указанный в личном кабинете URL-адрес приходят POST данные в таком формате:
{| class="wikitable"
|test
|int
|1 ― указывает что запрос тестовый, отсутствие параметра ― боевой
|-
|change
|[] json
|Массив изменений в json формате
|-
|Номер контейнера : тип уведомления
|
|Тип уведомления: do1 ― появилась ДО1; 13014 ― появилось сообщение CMN.13014
|}
пример POST запроса:

test=1&change={"TEST0000001":"do1","TEST0000002":"13014"}

'''Работа запросов webhook'''

Как только url ответил с кодом 200, уведомление считается '''доставленным''', но если код ответа отличный от 200, то происходит еще 5 попыток достучаться до указанного url с интервал между попытками примерно 1-2 минуты.

API Слежение (для Груз на СВХ)

2024-11-13T09:12:59Z

Ivakin: /* Webhook */

== О сервисе Слежение ==
Сервис "Слежение" для "Груз на СВХ" <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki> позволяет ставить контейнеры и авианакладные на слежение с получением результатов размещения на складе и таможенного оформления грузов в контейнере через личный кабинет.

Отправляет уведомления на почту и URL-адрес по webhook о появлении новой информации по указанным контейнерам. Ставить и снимать контейнеры со слежения можно как через личный кабинет так и по API. Почта, URL-адрес для уведомлений и события для уведомления настраиваются только через личный кабинет.

== API ==
Доступ к API предоставляется по URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki>. Для использования сервиса необходима авторизация с помощью логина и пароля.

Логин и пароль для обращения по API необходимо получить в личном кабинете <nowiki>https://www.alta.ru/user/</nowiki>, заключив договор на использование онлайн-сервисов. В настройках договора будут указаны технический логин и пароль.

Тарификация производится так же как при постановке на слежение через личный кабинет.

API позволяет ставить, снимать со слежения и просматривать списки контейнеров и авианакладных находящихся на слежении. Уведомления об обнаружении новой информации приходят на указанные почтовые ящики в кабинете слежения <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki>

=== Формирование URL запроса ===
Запросы направляются на URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki><МЕТОД>/
{| class="wikitable"
|Метод
|Тип запроса
|Описание
|-
|help
|GET
|Вызывает справку - выдает доступные методы API и списки передаваемых параметров
|-
|test
|GET
|Проверка работы API и правильности формирования запроса - выдает результат проверки правильности секрета, правильную строку для расчета секрета и логин (если отправлен верный секрет)
|-
|info
|GET
|Информация об аккаунте и настройках слежения
|-
|set
|POST
|Постановка контейнеров на слежение, POST-параметр data=<номера контейнеров / авианакладных через запятую “,”>
|-
|del
|POST
|Снятие контейнеров со слежения, POST-параметр ids=<id контейнеров / авианакладных через запятую “,”> или data=<имена контейнеров / авианакладных через запятую “,”> (id контейнера приходит при постановке на слежение)
|-
|list
|GET
|Просмотр статуса всех отслеживаемых контейнеров. Через этот метод можно узнать id контейнеров находящихся на слежении. Можно указать нужные контейнеры: ids=<id контейнеров через запятую “,”> или data=<имена контейнеров через запятую “,”>
|}
обязательные GET параметры в URL

# логин ― логин сервис аккаунта в открытом виде
# секрет ― MD5-хеш от сгенерированной строки (все параметры разделены знаком “:” (двоеточие)): параметры_GET + параметры_POST + метод + логин + md5(пароль)

Формирование секрета

secret = md5("{параметры_GET}:{параметры_POST}:{метод}:{логин}:{md5(пароль)}")

параметры_GET ― это значения прочих get параметров помимо логина, секрета и метода, разделенные “:”

параметры_POST ― это значения post параметров для методов set и del, разделенные “:”

Пример расчёта секрета для метода del, логина testlogin и пароля testpassword:

Если дополнительный GET параметр foo = bar , то для расчета секрета надо использовать параметры_GET = “bar”

Для метода del надо указывать id номера контейнеров в POST параметре ids через запятую. Если ids=11,55,33 , то для расчета секрета параметры_POST = “11,55,33”

Итоговая строка секрета = md5("bar:11,55,33:del:testlogin:md5(testpassword)")

Пример запроса списка контейнеров:

Метод list, пользователь с логином testlogin и пароль testpassword

Прочие параметры_GET - отсутствуют, параметры_POST отсутствуют, так как это GET метод

Вычисляем секрет: secret = md5("пусто:пусто:list:testlogin:md5(testpassword)") = md5("::list:testlogin:md5(testpassword)") = 18a3a18768475d5fbaf244f291212e86

Таким образом, итоговый URL, на который совершается GET-запрос: <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/list/?login=testlogin&secret=18a3a18768475d5fbaf244f291212e86</nowiki>

=== Ответ ===

<big>Метод</big> '''<big>List</big>'''
Описание полей возвращаемых данных
{| class="wikitable"
|data
|[]
|Корневой элемент, содержит массив записей слежения *
|-
|id
|int
|Идентификатор записи слежения
|-
|created
|str
|Дата постановки на слежение 3
|-
|updated
|str
|Дата последнего обновления информации сервисом
|-
|num
|str
|Номер контейнера или авианакладной
|-
|type
|str
|Тип слежения: К - контейнер, А - авианакладная
|-
|status
|str
|Статус слежения 1
|-
|do1
|int
|Количество записей ДО1 по контейнеру
|-
|cmn13014
|int
|Количество сообщений 13014 по контейнеру
|-
|infoDateMax
|str
|Дата последних полученных данных по контейнеру
|}
<nowiki>*</nowiki> максимальный размер возвращаемых данных 9900 записей

1 Статусы слежения:
{| class="wikitable"
|new
|Новый, запись только что добавлена
|-
|process
|В процессе обработки, проходят проверки
|-
|old
|В процессе обработки, имеется старая информация, старше чем указано в настройках ЛК в параметре Уведомлять о старой информации 2
|-
|busy
|Занят, происходит запись информации
|-
|arh
|Контейнер перенесен в архив (удален), автоматически помещается в архив если статус old более 90 дней
|}

2 Уведомлять о старой информации ― Параметр включает уведомления по событиям слежения с даты ранее даты постановки на слежение created 3

Например, если в параметре установлено 3 дня, то при постановке контейнера на слежение он уведомит Вас об информации, которая появилась не старше чем 3 дня назад.

<big>Пример ответа:</big>

Код ответа 200:

{

"data": [

{

"id": 12,

"created": "2023-01-19 12:03:45",

"updated": "2023-04-11 18:11:06",

"num": "XXXX1018593",

"status": "process",

"do1": 0,

"cmn13014": 0,

"infoDateMax": null,

},

...

]

}

<big>Метод</big> '''<big>Set</big>'''

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|-
|add
|[]
|Массив успешно добавленных контейнеров
|-
|no
|[]
|Массив контейнеров, которые не добавлены. Каждый элемент содержит массив, состоящий из номера контейнера и статуса
|}

<big>Пример ответа:</big>

{

"add": ["TEST0000001"],

"success": true,

"no": [

[ "TEST0000002", "Новый" ]

]

}

<big>Метод</big> '''<big>Del</big>'''
аналогичен методу set

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|}

<big>Пример ответа:</big>

{

"success": true

}

<big>Метод</big> '''<big>Info</big>'''
Описание полей возвращаемых данных

{| class="wikitable"
|success
|bol
|true ― успешный запрос
|-
|data
|[]
|Массив, содержащий настройки аккаунта
|-
|notifyEmail
|bool
|1 ― включены уведомления на email
|-
|notifyOneMail
|bool
|1 ― отдельное письмо для каждого результата. Если в течении минуты пришло несколько контейнеров, то при значении "0" они будут объединены в одно письмо
|-
|notifyTG
|bool
|1 ― включены уведомления в телеграмм
|-
|notifyWebhook
|bool
|1 ― включены уведомления webhook
|-
|webhook
|str
|URL-адрес webhook
|-
|tgId
|int
|ID привязанного телеграмм аккаунта
|-
|sa_balance
|float
|Баланс сервис аккаунта
|-
|service_price
|float
|Цена за уведомление
|-
|freezing
|float
|Заморожено средств
|-
|addArh
|bool
|Разрешено добавлять архивные
|-
|sa_login
|str
|Логин выбранного сервис аккаунта
|-
|notifyAddDoc
|bool
|1 ― добавляет номер документа-основания (ДО1 или CMN.13014) в текст уведомления
|-
|notifyOldDay
|int
|Кол-во дней. При постановке задачи на слежение учитывается полученная ранее информация. Если параметр = 3 дня, то будет уведомление об информации не старше 3 дней. Влияет только на начало слежения
|-
|notifyLoginEmail
|bool
|Уведомление на email аккаунта
|-
|notify13014
|bool
|Уведомлять о получении сообщений 13014
|-
|notifyDO1
|bool
|Уведомлять о появлении новых ДО1
|-
|login
|str
|Ваш логин
|-
|emails
|[]
|Массив Ваших дополнительных email адресов для уведомлений. Содержит массив значений ― email адрес (ключевое поле) и состояние - включен (true) или нет (false)
|}

<big>Пример ответа:</big>

{

"data": {

"notifyEmail": 0,

"service_price": 1,

"notifyAddDoc": 1,

"notifyTG": 0,

"freezing": 147,

"notifyWebhook": 0,

"webhook": null,

"addArh": 0,

"sa_login": "сервис аккаунт",

"notifyDO1": 0,

"tgId": 11122233344,

"sa_balance": 500,

"notifyOldDay": 3,

"notifyLoginEmail": 0,

"notify13014": 1,

"notifyOneMail": 0,

"login": "ваш логин",

"emails": {

"первый@": false,

"второй@": true

},

},

"success": true

}

=== Webhook ===

По Webhook на указанный в личном кабинете URL-адрес приходят POST данные в таком формате:
{| class="wikitable"
|test
|int
|1 ― указывает что запрос тестовый, отсутствие параметра ― боевой
|-
|change
|[] json
|Массив изменений в json формате
|-
|Номер контейнера : тип уведомления
|
|Тип уведомления: do1 ― появилась ДО1; 13014 ― появилось сообщение CMN.13014
|}
пример POST запроса:

test=1&change={"TEST0000001":"do1","TEST0000002":"13014"}

'''Работа запросов webhook'''

Как только url ответил с кодом 200, уведомление считается '''доставленным''', но если код ответа отличный от 200, то происходит еще 5 попыток достучаться до указанного url с интервал между попытками примерно 1-2 минуты.

=== Возможные ошибки ===
При возникновении ошибок возвращается код ответа сервера отличный от '''200''', а также описание ошибки в JSON-массиве.

код ответа '''400''':

{"success":false,"info":"Нет авторизации","code":101}

API Слежение (для Груз на СВХ)

2024-11-13T09:07:42Z

Ivakin:

== О сервисе Слежение ==
Сервис "Слежение" для "Груз на СВХ" <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki> позволяет ставить контейнеры и авианакладные на слежение с получением результатов размещения на складе и таможенного оформления грузов в контейнере через личный кабинет.

Отправляет уведомления на почту и URL-адрес по webhook о появлении новой информации по указанным контейнерам. Ставить и снимать контейнеры со слежения можно как через личный кабинет так и по API. Почта, URL-адрес для уведомлений и события для уведомления настраиваются только через личный кабинет.

== API ==
Доступ к API предоставляется по URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki>. Для использования сервиса необходима авторизация с помощью логина и пароля.

Логин и пароль для обращения по API необходимо получить в личном кабинете <nowiki>https://www.alta.ru/user/</nowiki>, заключив договор на использование онлайн-сервисов. В настройках договора будут указаны технический логин и пароль.

Тарификация производится так же как при постановке на слежение через личный кабинет.

API позволяет ставить, снимать со слежения и просматривать списки контейнеров и авианакладных находящихся на слежении. Уведомления об обнаружении новой информации приходят на указанные почтовые ящики в кабинете слежения <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki>

=== Формирование URL запроса ===
Запросы направляются на URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki><МЕТОД>/
{| class="wikitable"
|Метод
|Тип запроса
|Описание
|-
|help
|GET
|Вызывает справку - выдает доступные методы API и списки передаваемых параметров
|-
|test
|GET
|Проверка работы API и правильности формирования запроса - выдает результат проверки правильности секрета, правильную строку для расчета секрета и логин (если отправлен верный секрет)
|-
|info
|GET
|Информация об аккаунте и настройках слежения
|-
|set
|POST
|Постановка контейнеров на слежение, POST-параметр data=<номера контейнеров / авианакладных через запятую “,”>
|-
|del
|POST
|Снятие контейнеров со слежения, POST-параметр ids=<id контейнеров / авианакладных через запятую “,”> или data=<имена контейнеров / авианакладных через запятую “,”> (id контейнера приходит при постановке на слежение)
|-
|list
|GET
|Просмотр статуса всех отслеживаемых контейнеров. Через этот метод можно узнать id контейнеров находящихся на слежении. Можно указать нужные контейнеры: ids=<id контейнеров через запятую “,”> или data=<имена контейнеров через запятую “,”>
|}
обязательные GET параметры в URL

# логин ― логин сервис аккаунта в открытом виде
# секрет ― MD5-хеш от сгенерированной строки (все параметры разделены знаком “:” (двоеточие)): параметры_GET + параметры_POST + метод + логин + md5(пароль)

Формирование секрета

secret = md5("{параметры_GET}:{параметры_POST}:{метод}:{логин}:{md5(пароль)}")

параметры_GET ― это значения прочих get параметров помимо логина, секрета и метода, разделенные “:”

параметры_POST ― это значения post параметров для методов set и del, разделенные “:”

Пример расчёта секрета для метода del, логина testlogin и пароля testpassword:

Если дополнительный GET параметр foo = bar , то для расчета секрета надо использовать параметры_GET = “bar”

Для метода del надо указывать id номера контейнеров в POST параметре ids через запятую. Если ids=11,55,33 , то для расчета секрета параметры_POST = “11,55,33”

Итоговая строка секрета = md5("bar:11,55,33:del:testlogin:md5(testpassword)")

Пример запроса списка контейнеров:

Метод list, пользователь с логином testlogin и пароль testpassword

Прочие параметры_GET - отсутствуют, параметры_POST отсутствуют, так как это GET метод

Вычисляем секрет: secret = md5("пусто:пусто:list:testlogin:md5(testpassword)") = md5("::list:testlogin:md5(testpassword)") = 18a3a18768475d5fbaf244f291212e86

Таким образом, итоговый URL, на который совершается GET-запрос: <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/list/?login=testlogin&secret=18a3a18768475d5fbaf244f291212e86</nowiki>

=== Ответ ===

<big>Метод</big> '''<big>List</big>'''
Описание полей возвращаемых данных
{| class="wikitable"
|data
|[]
|Корневой элемент, содержит массив записей слежения *
|-
|id
|int
|Идентификатор записи слежения
|-
|created
|str
|Дата постановки на слежение 3
|-
|updated
|str
|Дата последнего обновления информации сервисом
|-
|num
|str
|Номер контейнера или авианакладной
|-
|type
|str
|Тип слежения: К - контейнер, А - авианакладная
|-
|status
|str
|Статус слежения 1
|-
|do1
|int
|Количество записей ДО1 по контейнеру
|-
|cmn13014
|int
|Количество сообщений 13014 по контейнеру
|-
|infoDateMax
|str
|Дата последних полученных данных по контейнеру
|}
<nowiki>*</nowiki> максимальный размер возвращаемых данных 9900 записей

1 Статусы слежения:
{| class="wikitable"
|new
|Новый, запись только что добавлена
|-
|process
|В процессе обработки, проходят проверки
|-
|old
|В процессе обработки, имеется старая информация, старше чем указано в настройках ЛК в параметре Уведомлять о старой информации 2
|-
|busy
|Занят, происходит запись информации
|-
|arh
|Контейнер перенесен в архив (удален), автоматически помещается в архив если статус old более 90 дней
|}

2 Уведомлять о старой информации ― Параметр включает уведомления по событиям слежения с даты ранее даты постановки на слежение created 3

Например, если в параметре установлено 3 дня, то при постановке контейнера на слежение он уведомит Вас об информации, которая появилась не старше чем 3 дня назад.

<big>Пример ответа:</big>

Код ответа 200:

{

"data": [

{

"id": 12,

"created": "2023-01-19 12:03:45",

"updated": "2023-04-11 18:11:06",

"num": "XXXX1018593",

"status": "process",

"do1": 0,

"cmn13014": 0,

"infoDateMax": null,

},

...

]

}

<big>Метод</big> '''<big>Set</big>'''

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|-
|add
|[]
|Массив успешно добавленных контейнеров
|-
|no
|[]
|Массив контейнеров, которые не добавлены. Каждый элемент содержит массив, состоящий из номера контейнера и статуса
|}

<big>Пример ответа:</big>

{

"add": ["TEST0000001"],

"success": true,

"no": [

[ "TEST0000002", "Новый" ]

]

}

<big>Метод</big> '''<big>Del</big>'''
аналогичен методу set

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|}

<big>Пример ответа:</big>

{

"success": true

}

<big>Метод</big> '''<big>Info</big>'''
Описание полей возвращаемых данных

{| class="wikitable"
|success
|bol
|true ― успешный запрос
|-
|data
|[]
|Массив, содержащий настройки аккаунта
|-
|notifyEmail
|bool
|1 ― включены уведомления на email
|-
|notifyOneMail
|bool
|1 ― отдельное письмо для каждого результата. Если в течении минуты пришло несколько контейнеров, то при значении "0" они будут объединены в одно письмо
|-
|notifyTG
|bool
|1 ― включены уведомления в телеграмм
|-
|notifyWebhook
|bool
|1 ― включены уведомления webhook
|-
|webhook
|str
|URL-адрес webhook
|-
|tgId
|int
|ID привязанного телеграмм аккаунта
|-
|sa_balance
|float
|Баланс сервис аккаунта
|-
|service_price
|float
|Цена за уведомление
|-
|freezing
|float
|Заморожено средств
|-
|addArh
|bool
|Разрешено добавлять архивные
|-
|sa_login
|str
|Логин выбранного сервис аккаунта
|-
|notifyAddDoc
|bool
|1 ― добавляет номер документа-основания (ДО1 или CMN.13014) в текст уведомления
|-
|notifyOldDay
|int
|Кол-во дней. При постановке задачи на слежение учитывается полученная ранее информация. Если параметр = 3 дня, то будет уведомление об информации не старше 3 дней. Влияет только на начало слежения
|-
|notifyLoginEmail
|bool
|Уведомление на email аккаунта
|-
|notify13014
|bool
|Уведомлять о получении сообщений 13014
|-
|notifyDO1
|bool
|Уведомлять о появлении новых ДО1
|-
|login
|str
|Ваш логин
|-
|emails
|[]
|Массив Ваших дополнительных email адресов для уведомлений. Содержит массив значений ― email адрес (ключевое поле) и состояние - включен (true) или нет (false)
|}

<big>Пример ответа:</big>

{

"data": {

"notifyEmail": 0,

"service_price": 1,

"notifyAddDoc": 1,

"notifyTG": 0,

"freezing": 147,

"notifyWebhook": 0,

"webhook": null,

"addArh": 0,

"sa_login": "сервис аккаунт",

"notifyDO1": 0,

"tgId": 11122233344,

"sa_balance": 500,

"notifyOldDay": 3,

"notifyLoginEmail": 0,

"notify13014": 1,

"notifyOneMail": 0,

"login": "ваш логин",

"emails": {

"первый@": false,

"второй@": true

},

},

"success": true

}

=== Webhook ===

По Webhook на указанный в личном кабинете URL-адрес приходят POST данные в таком формате:
{| class="wikitable"
|test
|int
|1 ― указывает что запрос тестовый, отсутствие параметра ― боевой
|-
|change
|[] json
|Массив изменений в json формате
|-
|Номер контейнера : тип уведомления
|
|Тип уведомления: do1 ― появилась ДО1; 13014 ― появилось сообщение CMN.13014
|}
пример POST запроса:

test=1&change={"TEST0000001":"do1","TEST0000002":"13014"}

=== Возможные ошибки ===
При возникновении ошибок возвращается код ответа сервера отличный от '''200''', а также описание ошибки в JSON-массиве.

код ответа '''400''':

{"success":false,"info":"Нет авторизации","code":101}

API Слежение (для Груз на СВХ)

2024-11-06T15:08:14Z

Ivakin: /* Ответ */

== О сервисе Слежение ==
Сервис "Слежение" для "Груз на СВХ" <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki> позволяет ставить контейнеры и авианакладные на слежение с получением результатов размещения на складе и таможенного оформления грузов в контейнере через личный кабинет.

Отправляет уведомления на почту и URL-адрес по webhook о появлении новой информации по указанным контейнерам. Ставить и снимать контейнеры со слежения можно как через личный кабинет так и по API. Почта, URL-адрес для уведомлений и события для уведомления настраиваются только через личный кабинет.

== API ==
Доступ к API предоставляется по URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki>. Для использования сервиса необходима авторизация с помощью логина и пароля.

Логин и пароль для обращения по API необходимо получить в личном кабинете <nowiki>https://www.alta.ru/user/</nowiki>, заключив договор на использование онлайн-сервисов. В настройках договора будут указаны технический логин и пароль.

Тарификация производится так же как при постановке на слежение через личный кабинет.

API позволяет ставить, снимать со слежения и просматривать списки контейнеров и авианакладных находящихся на слежении. Уведомления об обнаружении новой информации приходят на указанные почтовые ящики в кабинете слежения <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki>

=== Формирование URL запроса ===
Запросы направляются на URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki><МЕТОД>/
{| class="wikitable"
|Метод
|Тип запроса
|Описание
|-
|help
|GET
|Вызывает справку - выдает доступные методы API и списки передаваемых параметров
|-
|test
|GET
|Проверка работы API и правильности формирования запроса - выдает результат проверки правильности секрета, правильную строку для расчета секрета и логин (если отправлен верный секрет)
|-
|info
|GET
|Информация об аккаунте и настройках слежения
|-
|set
|POST
|Постановка контейнеров на слежение, POST-параметр data=<номера контейнеров / авианакладных через запятую “,”>
|-
|del
|POST
|Снятие контейнеров со слежения, POST-параметр ids=<id контейнеров / авианакладных через запятую “,”> или data=<имена контейнеров / авианакладных через запятую “,”> (id контейнера приходит при постановке на слежение)
|-
|list
|GET
|Просмотр статуса всех отслеживаемых контейнеров. Через этот метод можно узнать id контейнеров находящихся на слежении. Можно указать нужные контейнеры: ids=<id контейнеров через запятую “,”> или data=<имена контейнеров через запятую “,”>
|}
обязательные GET параметры в URL

# логин ― логин сервис аккаунта в открытом виде
# секрет ― MD5-хеш от сгенерированной строки (все параметры разделены знаком “:” (двоеточие)): параметры_GET + параметры_POST + метод + логин + md5(пароль)

Формирование секрета

secret = md5("{параметры_GET}:{параметры_POST}:{метод}:{логин}:{md5(пароль)}")

параметры_GET ― это значения прочих get параметров помимо логина, секрета и метода, разделенные “:”

параметры_POST ― это значения post параметров для методов set и del, разделенные “:”

Пример расчёта секрета для метода del, логина testlogin и пароля testpassword:

Если дополнительный GET параметр foo = bar , то для расчета секрета надо использовать параметры_GET = “bar”

Для метода del надо указывать id номера контейнеров в POST параметре ids через запятую. Если ids=11,55,33 , то для расчета секрета параметры_POST = “11,55,33”

Итоговая строка секрета = md5("bar:11,55,33:del:testlogin:md5(testpassword)")

Пример запроса списка контейнеров:

Метод list, пользователь с логином testlogin и пароль testpassword

Прочие параметры_GET - отсутствуют, параметры_POST отсутствуют, так как это GET метод

Вычисляем секрет: secret = md5("пусто:пусто:list:testlogin:md5(testpassword)") = md5("::list:testlogin:md5(testpassword)") = 18a3a18768475d5fbaf244f291212e86

Таким образом, итоговый URL, на который совершается GET-запрос: <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/list/?login=testlogin&secret=18a3a18768475d5fbaf244f291212e86</nowiki>

=== Ответ ===

<big>Метод</big> '''<big>List</big>'''
Описание полей возвращаемых данных
{| class="wikitable"
|data
|[]
|Корневой элемент, содержит массив записей слежения *
|-
|id
|int
|Идентификатор записи слежения
|-
|created
|str
|Дата постановки на слежение 3
|-
|updated
|str
|Дата последнего обновления информации сервисом
|-
|num
|str
|Номер контейнера или авианакладной
|-
|type
|str
|Тип слежения: К - контейнер, А - авианакладная
|-
|status
|str
|Статус слежения 1
|-
|do1
|int
|Количество записей ДО1 по контейнеру
|-
|cmn13014
|int
|Количество сообщений 13014 по контейнеру
|-
|infoDateMax
|str
|Дата последних полученных данных по контейнеру
|}
<nowiki>*</nowiki> максимальный размер возвращаемых данных 9900 записей

1 Статусы слежения:
{| class="wikitable"
|new
|Новый, запись только что добавлена
|-
|process
|В процессе обработки, проходят проверки
|-
|old
|В процессе обработки, имеется старая информация, старше чем указано в настройках ЛК в параметре Уведомлять о старой информации 2
|-
|busy
|Занят, происходит запись информации
|-
|arh
|Контейнер перенесен в архив (удален), автоматически помещается в архив если статус old более 90 дней
|}

2 Уведомлять о старой информации ― Параметр включает уведомления по событиям слежения с даты ранее даты постановки на слежение created 3

Например, если в параметре установлено 3 дня, то при постановке контейнера на слежение он уведомит Вас об информации, которая появилась не старше чем 3 дня назад.

<big>Пример ответа:</big>

Код ответа 200:

{

"data": [

{

"id": 12,

"created": "2023-01-19 12:03:45",

"updated": "2023-04-11 18:11:06",

"num": "XXXX1018593",

"status": "process",

"do1": 0,

"cmn13014": 0,

"infoDateMax": null,

},

...

]

}

<big>Метод</big> '''<big>Set</big>'''

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|-
|add
|[]
|Массив успешно добавленных контейнеров
|-
|no
|[]
|Массив контейнеров, которые не добавлены. Каждый элемент содержит массив, состоящий из номера контейнера и статуса
|}

<big>Пример ответа:</big>

{

"add": ["TEST0000001"],

"success": true,

"no": [

[ "TEST0000002", "Новый" ]

]

}

<big>Метод</big> '''<big>Del</big>'''
аналогичен методу set

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|}

<big>Пример ответа:</big>

{

"success": true

}

<big>Метод</big> '''<big>Info</big>'''
Описание полей возвращаемых данных

{| class="wikitable"
|success
|bol
|true ― успешный запрос
|-
|data
|[]
|Массив, содержащий настройки аккаунта
|-
|notifyEmail
|bool
|1 ― включены уведомления на email
|-
|notifyOneMail
|bool
|1 ― отдельное письмо для каждого результата. Если в течении минуты пришло несколько контейнеров, то при значении "0" они будут объединены в одно письмо
|-
|notifyTG
|bool
|1 ― включены уведомления в телеграмм
|-
|notifyWebhook
|bool
|1 ― включены уведомления webhook
|-
|webhook
|str
|URL-адрес webhook
|-
|tgId
|int
|ID привязанного телеграмм аккаунта
|-
|sa_balance
|float
|Баланс сервис аккаунта
|-
|service_price
|float
|Цена за уведомление
|-
|freezing
|float
|Заморожено средств
|-
|addArh
|bool
|Разрешено добавлять архивные
|-
|sa_login
|str
|Логин выбранного сервис аккаунта
|-
|notifyAddDoc
|bool
|1 ― добавляет номер документа-основания (ДО1 или CMN.13014) в текст уведомления
|-
|notifyOldDay
|int
|Кол-во дней. При постановке задачи на слежение учитывается полученная ранее информация. Если параметр = 3 дня, то будет уведомление об информации не старше 3 дней. Влияет только на начало слежения
|-
|notifyLoginEmail
|bool
|Уведомление на email аккаунта
|-
|notify13014
|bool
|Уведомлять о получении сообщений 13014
|-
|notifyDO1
|bool
|Уведомлять о появлении новых ДО1
|-
|login
|str
|Ваш логин
|-
|emails
|[]
|Массив Ваших дополнительных email адресов для уведомлений. Содержит массив значений ― email адрес (ключевое поле) и состояние - включен (true) или нет (false)
|}

<big>Пример ответа:</big>

{

"data": {

"notifyEmail": 0,

"service_price": 1,

"notifyAddDoc": 1,

"notifyTG": 0,

"freezing": 147,

"notifyWebhook": 0,

"webhook": null,

"addArh": 0,

"sa_login": "сервис аккаунт",

"notifyDO1": 0,

"tgId": 11122233344,

"sa_balance": 500,

"notifyOldDay": 3,

"notifyLoginEmail": 0,

"notify13014": 1,

"notifyOneMail": 0,

"login": "ваш логин",

"emails": {

"первый@": false,

"второй@": true

},

},

"success": true

}

'''<big>Webhook</big>'''

По Webhook на указанный в личном кабинете URL-адрес приходят POST данные в таком формате:
{| class="wikitable"
|test
|int
|1 ― указывает что запрос тестовый, отсутствие параметра ― боевой
|-
|change
|[] json
|Массив изменений в json формате
|-
|Номер контейнера : тип уведомления
|
|Тип уведомления: do1 ― появилась ДО1; 13014 ― появилось сообщение CMN.13014
|}
пример POST запроса:

test=1&change={"TEST0000001":"do1","TEST0000002":"13014"}

=== Возможные ошибки ===
При возникновении ошибок возвращается код ответа сервера отличный от '''200''', а также описание ошибки в JSON-массиве.

код ответа '''400''':

{"success":false,"info":"Нет авторизации","code":101}

API Слежение (для Груз на СВХ)

2024-11-06T14:56:17Z

Ivakin: /* API */

== О сервисе Слежение ==
Сервис "Слежение" для "Груз на СВХ" <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki> позволяет ставить контейнеры и авианакладные на слежение с получением результатов размещения на складе и таможенного оформления грузов в контейнере через личный кабинет.

Отправляет уведомления на почту и URL-адрес по webhook о появлении новой информации по указанным контейнерам. Ставить и снимать контейнеры со слежения можно как через личный кабинет так и по API. Почта, URL-адрес для уведомлений и события для уведомления настраиваются только через личный кабинет.

== API ==
Доступ к API предоставляется по URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki>. Для использования сервиса необходима авторизация с помощью логина и пароля.

Логин и пароль для обращения по API необходимо получить в личном кабинете <nowiki>https://www.alta.ru/user/</nowiki>, заключив договор на использование онлайн-сервисов. В настройках договора будут указаны технический логин и пароль.

Тарификация производится так же как при постановке на слежение через личный кабинет.

API позволяет ставить, снимать со слежения и просматривать списки контейнеров и авианакладных находящихся на слежении. Уведомления об обнаружении новой информации приходят на указанные почтовые ящики в кабинете слежения <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki>

=== Формирование URL запроса ===
Запросы направляются на URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki><МЕТОД>/
{| class="wikitable"
|Метод
|Тип запроса
|Описание
|-
|help
|GET
|Вызывает справку - выдает доступные методы API и списки передаваемых параметров
|-
|test
|GET
|Проверка работы API и правильности формирования запроса - выдает результат проверки правильности секрета, правильную строку для расчета секрета и логин (если отправлен верный секрет)
|-
|info
|GET
|Информация об аккаунте и настройках слежения
|-
|set
|POST
|Постановка контейнеров на слежение, POST-параметр data=<номера контейнеров / авианакладных через запятую “,”>
|-
|del
|POST
|Снятие контейнеров со слежения, POST-параметр ids=<id контейнеров / авианакладных через запятую “,”> или data=<имена контейнеров / авианакладных через запятую “,”> (id контейнера приходит при постановке на слежение)
|-
|list
|GET
|Просмотр статуса всех отслеживаемых контейнеров. Через этот метод можно узнать id контейнеров находящихся на слежении. Можно указать нужные контейнеры: ids=<id контейнеров через запятую “,”> или data=<имена контейнеров через запятую “,”>
|}
обязательные GET параметры в URL

# логин ― логин сервис аккаунта в открытом виде
# секрет ― MD5-хеш от сгенерированной строки (все параметры разделены знаком “:” (двоеточие)): параметры_GET + параметры_POST + метод + логин + md5(пароль)

Формирование секрета

secret = md5("{параметры_GET}:{параметры_POST}:{метод}:{логин}:{md5(пароль)}")

параметры_GET ― это значения прочих get параметров помимо логина, секрета и метода, разделенные “:”

параметры_POST ― это значения post параметров для методов set и del, разделенные “:”

Пример расчёта секрета для метода del, логина testlogin и пароля testpassword:

Если дополнительный GET параметр foo = bar , то для расчета секрета надо использовать параметры_GET = “bar”

Для метода del надо указывать id номера контейнеров в POST параметре ids через запятую. Если ids=11,55,33 , то для расчета секрета параметры_POST = “11,55,33”

Итоговая строка секрета = md5("bar:11,55,33:del:testlogin:md5(testpassword)")

Пример запроса списка контейнеров:

Метод list, пользователь с логином testlogin и пароль testpassword

Прочие параметры_GET - отсутствуют, параметры_POST отсутствуют, так как это GET метод

Вычисляем секрет: secret = md5("пусто:пусто:list:testlogin:md5(testpassword)") = md5("::list:testlogin:md5(testpassword)") = 18a3a18768475d5fbaf244f291212e86

Таким образом, итоговый URL, на который совершается GET-запрос: <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/list/?login=testlogin&secret=18a3a18768475d5fbaf244f291212e86</nowiki>

=== Ответ ===

<big>Метод</big> '''<big>List</big>'''
Описание полей возвращаемых данных
{| class="wikitable"
|data
|[]
|Корневой элемент, содержит массив записей слежения *
|-
|id
|int
|Идентификатор записи слежения
|-
|created
|str
|Дата постановки на слежение 3
|-
|updated
|str
|Дата последнего обновления информации сервисом
|-
|num
|str
|Номер контейнера
|-
|status
|str
|Статус слежения 1
|-
|do1
|int
|Количество записей ДО1 по контейнеру
|-
|cmn13014
|int
|Количество сообщений 13014 по контейнеру
|-
|infoDateMax
|str
|Дата последних полученных данных по контейнеру
|}
<nowiki>*</nowiki> максимальный размер возвращаемых данных 9900 записей

1 Статусы слежения:
{| class="wikitable"
|new
|Новый, запись только что добавлена
|-
|process
|В процессе обработки, проходят проверки
|-
|old
|В процессе обработки, имеется старая информация, старше чем указано в настройках ЛК в параметре Уведомлять о старой информации 2
|-
|busy
|Занят, происходит запись информации
|-
|arh
|Контейнер перенесен в архив (удален), автоматически помещается в архив если статус old более 90 дней
|}

2 Уведомлять о старой информации ― Параметр включает уведомления по событиям слежения с даты ранее даты постановки на слежение created 3

Например, если в параметре установлено 3 дня, то при постановке контейнера на слежение он уведомит Вас об информации, которая появилась не старше чем 3 дня назад.

<big>Пример ответа:</big>

Код ответа 200:

{

"data": [

{

"id": 12,

"created": "2023-01-19 12:03:45",

"updated": "2023-04-11 18:11:06",

"num": "XXXX1018593",

"status": "process", - статус слежения

"do1": 0, - сколько записей ДО1 по контейнеру

"cmn13014": 0, - сколько сообщений 13014 по контейнеру

"infoDateMax": null, - максимальная дата полученная из сообщений

},

………..

]

}

<big>Метод</big> '''<big>Set</big>'''

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|-
|add
|[]
|Массив успешно добавленных контейнеров
|-
|no
|[]
|Массив контейнеров, которые не добавлены. Каждый элемент содержит массив, состоящий из номера контейнера и статуса
|}

<big>Пример ответа:</big>

{

"add": ["TEST0000001"],

"success": true,

"no": [

[ "TEST0000002", "Новый" ]

]

}

<big>Метод</big> '''<big>Del</big>'''
аналогичен методу set

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|}

<big>Пример ответа:</big>

{

"success": true

}

<big>Метод</big> '''<big>Info</big>'''
Описание полей возвращаемых данных

{| class="wikitable"
|success
|bol
|true ― успешный запрос
|-
|data
|[]
|Массив, содержащий настройки аккаунта
|-
|notifyEmail
|bool
|1 ― включены уведомления на email
|-
|notifyOneMail
|bool
|1 ― отдельное письмо для каждого результата. Если в течении минуты пришло несколько контейнеров, то при значении "0" они будут объединены в одно письмо
|-
|notifyTG
|bool
|1 ― включены уведомления в телеграмм
|-
|notifyWebhook
|bool
|1 ― включены уведомления webhook
|-
|webhook
|str
|URL-адрес webhook
|-
|tgId
|int
|ID привязанного телеграмм аккаунта
|-
|sa_balance
|float
|Баланс сервис аккаунта
|-
|service_price
|float
|Цена за уведомление
|-
|freezing
|float
|Заморожено средств
|-
|addArh
|bool
|Разрешено добавлять архивные
|-
|sa_login
|str
|Логин выбранного сервис аккаунта
|-
|notifyAddDoc
|bool
|1 ― добавляет номер документа-основания (ДО1 или CMN.13014) в текст уведомления
|-
|notifyOldDay
|int
|Кол-во дней. При постановке задачи на слежение учитывается полученная ранее информация. Если параметр = 3 дня, то будет уведомление об информации не старше 3 дней. Влияет только на начало слежения
|-
|notifyLoginEmail
|bool
|Уведомление на email аккаунта
|-
|notify13014
|bool
|Уведомлять о получении сообщений 13014
|-
|notifyDO1
|bool
|Уведомлять о появлении новых ДО1
|-
|login
|str
|Ваш логин
|-
|emails
|[]
|Массив Ваших дополнительных email адресов для уведомлений. Содержит массив значений ― email адрес (ключевое поле) и состояние - включен (true) или нет (false)
|}

<big>Пример ответа:</big>

{

"data": {

"notifyEmail": 0,

"service_price": 1,

"notifyAddDoc": 1,

"notifyTG": 0,

"freezing": 147,

"notifyWebhook": 0,

"webhook": null,

"addArh": 0,

"sa_login": "сервис аккаунт",

"notifyDO1": 0,

"tgId": 11122233344,

"sa_balance": 500,

"notifyOldDay": 3,

"notifyLoginEmail": 0,

"notify13014": 1,

"notifyOneMail": 0,

"login": "ваш логин",

"emails": {

"первый@": false,

"второй@": true

},

},

"success": true

}

'''<big>Webhook</big>'''

По Webhook на указанный в личном кабинете URL-адрес приходят POST данные в таком формате:
{| class="wikitable"
|test
|int
|1 ― указывает что запрос тестовый, отсутствие параметра ― боевой
|-
|change
|[] json
|Массив изменений в json формате
|-
|Номер контейнера : тип уведомления
|
|Тип уведомления: do1 ― появилась ДО1; 13014 ― появилось сообщение CMN.13014
|}
пример POST запроса:

test=1&change={"TEST0000001":"do1","TEST0000002":"13014"}

=== Возможные ошибки ===
При возникновении ошибок возвращается код ответа сервера отличный от '''200''', а также описание ошибки в JSON-массиве.

код ответа '''400''':

{"success":false,"info":"Нет авторизации","code":101}

API Слежение (для Груз на СВХ)

2024-11-06T14:55:47Z

Ivakin: /* О сервисе Слежение */

== О сервисе Слежение ==
Сервис "Слежение" для "Груз на СВХ" <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki> позволяет ставить контейнеры и авианакладные на слежение с получением результатов размещения на складе и таможенного оформления грузов в контейнере через личный кабинет.

Отправляет уведомления на почту и URL-адрес по webhook о появлении новой информации по указанным контейнерам. Ставить и снимать контейнеры со слежения можно как через личный кабинет так и по API. Почта, URL-адрес для уведомлений и события для уведомления настраиваются только через личный кабинет.

== API ==
Доступ к API предоставляется по URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki>. Для использования сервиса необходима авторизация с помощью логина и пароля.

Логин и пароль для обращения по API необходимо получить в личном кабинете <nowiki>https://www.alta.ru/user/</nowiki>, заключив договор на использование онлайн-сервисов. В настройках договора будут указаны технический логин и пароль.

Тарификация производится так же как при постановке на слежение через личный кабинет.

API позволяет ставить, снимать со слежения и просматривать списки контейнеров находящихся на слежении. Уведомления об обнаружении новой информации приходят на указанные почтовые ящики в кабинете слежения <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki>

=== Формирование URL запроса ===
Запросы направляются на URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki><МЕТОД>/
{| class="wikitable"
|Метод
|Тип запроса
|Описание
|-
|help
|GET
|Вызывает справку - выдает доступные методы API и списки передаваемых параметров
|-
|test
|GET
|Проверка работы API и правильности формирования запроса - выдает результат проверки правильности секрета, правильную строку для расчета секрета и логин (если отправлен верный секрет)
|-
|info
|GET
|Информация об аккаунте и настройках слежения
|-
|set
|POST
|Постановка контейнеров на слежение, POST-параметр data=<номера контейнеров / авианакладных через запятую “,”>
|-
|del
|POST
|Снятие контейнеров со слежения, POST-параметр ids=<id контейнеров / авианакладных через запятую “,”> или data=<имена контейнеров / авианакладных через запятую “,”> (id контейнера приходит при постановке на слежение)
|-
|list
|GET
|Просмотр статуса всех отслеживаемых контейнеров. Через этот метод можно узнать id контейнеров находящихся на слежении. Можно указать нужные контейнеры: ids=<id контейнеров через запятую “,”> или data=<имена контейнеров через запятую “,”>
|}
обязательные GET параметры в URL

# логин ― логин сервис аккаунта в открытом виде
# секрет ― MD5-хеш от сгенерированной строки (все параметры разделены знаком “:” (двоеточие)): параметры_GET + параметры_POST + метод + логин + md5(пароль)

Формирование секрета

secret = md5("{параметры_GET}:{параметры_POST}:{метод}:{логин}:{md5(пароль)}")

параметры_GET ― это значения прочих get параметров помимо логина, секрета и метода, разделенные “:”

параметры_POST ― это значения post параметров для методов set и del, разделенные “:”

Пример расчёта секрета для метода del, логина testlogin и пароля testpassword:

Если дополнительный GET параметр foo = bar , то для расчета секрета надо использовать параметры_GET = “bar”

Для метода del надо указывать id номера контейнеров в POST параметре ids через запятую. Если ids=11,55,33 , то для расчета секрета параметры_POST = “11,55,33”

Итоговая строка секрета = md5("bar:11,55,33:del:testlogin:md5(testpassword)")

Пример запроса списка контейнеров:

Метод list, пользователь с логином testlogin и пароль testpassword

Прочие параметры_GET - отсутствуют, параметры_POST отсутствуют, так как это GET метод

Вычисляем секрет: secret = md5("пусто:пусто:list:testlogin:md5(testpassword)") = md5("::list:testlogin:md5(testpassword)") = 18a3a18768475d5fbaf244f291212e86

Таким образом, итоговый URL, на который совершается GET-запрос: <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/list/?login=testlogin&secret=18a3a18768475d5fbaf244f291212e86</nowiki>

=== Ответ ===

<big>Метод</big> '''<big>List</big>'''
Описание полей возвращаемых данных
{| class="wikitable"
|data
|[]
|Корневой элемент, содержит массив записей слежения *
|-
|id
|int
|Идентификатор записи слежения
|-
|created
|str
|Дата постановки на слежение 3
|-
|updated
|str
|Дата последнего обновления информации сервисом
|-
|num
|str
|Номер контейнера
|-
|status
|str
|Статус слежения 1
|-
|do1
|int
|Количество записей ДО1 по контейнеру
|-
|cmn13014
|int
|Количество сообщений 13014 по контейнеру
|-
|infoDateMax
|str
|Дата последних полученных данных по контейнеру
|}
<nowiki>*</nowiki> максимальный размер возвращаемых данных 9900 записей

1 Статусы слежения:
{| class="wikitable"
|new
|Новый, запись только что добавлена
|-
|process
|В процессе обработки, проходят проверки
|-
|old
|В процессе обработки, имеется старая информация, старше чем указано в настройках ЛК в параметре Уведомлять о старой информации 2
|-
|busy
|Занят, происходит запись информации
|-
|arh
|Контейнер перенесен в архив (удален), автоматически помещается в архив если статус old более 90 дней
|}

2 Уведомлять о старой информации ― Параметр включает уведомления по событиям слежения с даты ранее даты постановки на слежение created 3

Например, если в параметре установлено 3 дня, то при постановке контейнера на слежение он уведомит Вас об информации, которая появилась не старше чем 3 дня назад.

<big>Пример ответа:</big>

Код ответа 200:

{

"data": [

{

"id": 12,

"created": "2023-01-19 12:03:45",

"updated": "2023-04-11 18:11:06",

"num": "XXXX1018593",

"status": "process", - статус слежения

"do1": 0, - сколько записей ДО1 по контейнеру

"cmn13014": 0, - сколько сообщений 13014 по контейнеру

"infoDateMax": null, - максимальная дата полученная из сообщений

},

………..

]

}

<big>Метод</big> '''<big>Set</big>'''

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|-
|add
|[]
|Массив успешно добавленных контейнеров
|-
|no
|[]
|Массив контейнеров, которые не добавлены. Каждый элемент содержит массив, состоящий из номера контейнера и статуса
|}

<big>Пример ответа:</big>

{

"add": ["TEST0000001"],

"success": true,

"no": [

[ "TEST0000002", "Новый" ]

]

}

<big>Метод</big> '''<big>Del</big>'''
аналогичен методу set

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|}

<big>Пример ответа:</big>

{

"success": true

}

<big>Метод</big> '''<big>Info</big>'''
Описание полей возвращаемых данных

{| class="wikitable"
|success
|bol
|true ― успешный запрос
|-
|data
|[]
|Массив, содержащий настройки аккаунта
|-
|notifyEmail
|bool
|1 ― включены уведомления на email
|-
|notifyOneMail
|bool
|1 ― отдельное письмо для каждого результата. Если в течении минуты пришло несколько контейнеров, то при значении "0" они будут объединены в одно письмо
|-
|notifyTG
|bool
|1 ― включены уведомления в телеграмм
|-
|notifyWebhook
|bool
|1 ― включены уведомления webhook
|-
|webhook
|str
|URL-адрес webhook
|-
|tgId
|int
|ID привязанного телеграмм аккаунта
|-
|sa_balance
|float
|Баланс сервис аккаунта
|-
|service_price
|float
|Цена за уведомление
|-
|freezing
|float
|Заморожено средств
|-
|addArh
|bool
|Разрешено добавлять архивные
|-
|sa_login
|str
|Логин выбранного сервис аккаунта
|-
|notifyAddDoc
|bool
|1 ― добавляет номер документа-основания (ДО1 или CMN.13014) в текст уведомления
|-
|notifyOldDay
|int
|Кол-во дней. При постановке задачи на слежение учитывается полученная ранее информация. Если параметр = 3 дня, то будет уведомление об информации не старше 3 дней. Влияет только на начало слежения
|-
|notifyLoginEmail
|bool
|Уведомление на email аккаунта
|-
|notify13014
|bool
|Уведомлять о получении сообщений 13014
|-
|notifyDO1
|bool
|Уведомлять о появлении новых ДО1
|-
|login
|str
|Ваш логин
|-
|emails
|[]
|Массив Ваших дополнительных email адресов для уведомлений. Содержит массив значений ― email адрес (ключевое поле) и состояние - включен (true) или нет (false)
|}

<big>Пример ответа:</big>

{

"data": {

"notifyEmail": 0,

"service_price": 1,

"notifyAddDoc": 1,

"notifyTG": 0,

"freezing": 147,

"notifyWebhook": 0,

"webhook": null,

"addArh": 0,

"sa_login": "сервис аккаунт",

"notifyDO1": 0,

"tgId": 11122233344,

"sa_balance": 500,

"notifyOldDay": 3,

"notifyLoginEmail": 0,

"notify13014": 1,

"notifyOneMail": 0,

"login": "ваш логин",

"emails": {

"первый@": false,

"второй@": true

},

},

"success": true

}

'''<big>Webhook</big>'''

По Webhook на указанный в личном кабинете URL-адрес приходят POST данные в таком формате:
{| class="wikitable"
|test
|int
|1 ― указывает что запрос тестовый, отсутствие параметра ― боевой
|-
|change
|[] json
|Массив изменений в json формате
|-
|Номер контейнера : тип уведомления
|
|Тип уведомления: do1 ― появилась ДО1; 13014 ― появилось сообщение CMN.13014
|}
пример POST запроса:

test=1&change={"TEST0000001":"do1","TEST0000002":"13014"}

=== Возможные ошибки ===
При возникновении ошибок возвращается код ответа сервера отличный от '''200''', а также описание ошибки в JSON-массиве.

код ответа '''400''':

{"success":false,"info":"Нет авторизации","code":101}

API Слежение (для Груз на СВХ)

2024-11-06T12:56:39Z

Ivakin: /* Ответ */

== О сервисе Слежение ==
Сервис "Слежение" для "Груз на СВХ" <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki> позволяет ставить контейнеры на слежение с получением результатов размещения на складе и таможенного оформления грузов в контейнере через личный кабинет.

Отправляет уведомления на почту и URL-адрес по webhook о появлении новой информации по указанным контейнерам. Ставить и снимать контейнеры со слежения можно как через личный кабинет так и по API. Почта, URL-адрес для уведомлений и события для уведомления настраиваются только через личный кабинет.

== API ==
Доступ к API предоставляется по URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki>. Для использования сервиса необходима авторизация с помощью логина и пароля.

Логин и пароль для обращения по API необходимо получить в личном кабинете <nowiki>https://www.alta.ru/user/</nowiki>, заключив договор на использование онлайн-сервисов. В настройках договора будут указаны технический логин и пароль.

Тарификация производится так же как при постановке на слежение через личный кабинет.

API позволяет ставить, снимать со слежения и просматривать списки контейнеров находящихся на слежении. Уведомления об обнаружении новой информации приходят на указанные почтовые ящики в кабинете слежения <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki>

=== Формирование URL запроса ===
Запросы направляются на URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki><МЕТОД>/
{| class="wikitable"
|Метод
|Тип запроса
|Описание
|-
|help
|GET
|Вызывает справку - выдает доступные методы API и списки передаваемых параметров
|-
|test
|GET
|Проверка работы API и правильности формирования запроса - выдает результат проверки правильности секрета, правильную строку для расчета секрета и логин (если отправлен верный секрет)
|-
|info
|GET
|Информация об аккаунте и настройках слежения
|-
|set
|POST
|Постановка контейнеров на слежение, POST-параметр data=<номера контейнеров / авианакладных через запятую “,”>
|-
|del
|POST
|Снятие контейнеров со слежения, POST-параметр ids=<id контейнеров / авианакладных через запятую “,”> или data=<имена контейнеров / авианакладных через запятую “,”> (id контейнера приходит при постановке на слежение)
|-
|list
|GET
|Просмотр статуса всех отслеживаемых контейнеров. Через этот метод можно узнать id контейнеров находящихся на слежении. Можно указать нужные контейнеры: ids=<id контейнеров через запятую “,”> или data=<имена контейнеров через запятую “,”>
|}
обязательные GET параметры в URL

# логин ― логин сервис аккаунта в открытом виде
# секрет ― MD5-хеш от сгенерированной строки (все параметры разделены знаком “:” (двоеточие)): параметры_GET + параметры_POST + метод + логин + md5(пароль)

Формирование секрета

secret = md5("{параметры_GET}:{параметры_POST}:{метод}:{логин}:{md5(пароль)}")

параметры_GET ― это значения прочих get параметров помимо логина, секрета и метода, разделенные “:”

параметры_POST ― это значения post параметров для методов set и del, разделенные “:”

Пример расчёта секрета для метода del, логина testlogin и пароля testpassword:

Если дополнительный GET параметр foo = bar , то для расчета секрета надо использовать параметры_GET = “bar”

Для метода del надо указывать id номера контейнеров в POST параметре ids через запятую. Если ids=11,55,33 , то для расчета секрета параметры_POST = “11,55,33”

Итоговая строка секрета = md5("bar:11,55,33:del:testlogin:md5(testpassword)")

Пример запроса списка контейнеров:

Метод list, пользователь с логином testlogin и пароль testpassword

Прочие параметры_GET - отсутствуют, параметры_POST отсутствуют, так как это GET метод

Вычисляем секрет: secret = md5("пусто:пусто:list:testlogin:md5(testpassword)") = md5("::list:testlogin:md5(testpassword)") = 18a3a18768475d5fbaf244f291212e86

Таким образом, итоговый URL, на который совершается GET-запрос: <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/list/?login=testlogin&secret=18a3a18768475d5fbaf244f291212e86</nowiki>

=== Ответ ===

<big>Метод</big> '''<big>List</big>'''
Описание полей возвращаемых данных
{| class="wikitable"
|data
|[]
|Корневой элемент, содержит массив записей слежения *
|-
|id
|int
|Идентификатор записи слежения
|-
|created
|str
|Дата постановки на слежение 3
|-
|updated
|str
|Дата последнего обновления информации сервисом
|-
|num
|str
|Номер контейнера
|-
|status
|str
|Статус слежения 1
|-
|do1
|int
|Количество записей ДО1 по контейнеру
|-
|cmn13014
|int
|Количество сообщений 13014 по контейнеру
|-
|infoDateMax
|str
|Дата последних полученных данных по контейнеру
|}
<nowiki>*</nowiki> максимальный размер возвращаемых данных 9900 записей

1 Статусы слежения:
{| class="wikitable"
|new
|Новый, запись только что добавлена
|-
|process
|В процессе обработки, проходят проверки
|-
|old
|В процессе обработки, имеется старая информация, старше чем указано в настройках ЛК в параметре Уведомлять о старой информации 2
|-
|busy
|Занят, происходит запись информации
|-
|arh
|Контейнер перенесен в архив (удален), автоматически помещается в архив если статус old более 90 дней
|}

2 Уведомлять о старой информации ― Параметр включает уведомления по событиям слежения с даты ранее даты постановки на слежение created 3

Например, если в параметре установлено 3 дня, то при постановке контейнера на слежение он уведомит Вас об информации, которая появилась не старше чем 3 дня назад.

<big>Пример ответа:</big>

Код ответа 200:

{

"data": [

{

"id": 12,

"created": "2023-01-19 12:03:45",

"updated": "2023-04-11 18:11:06",

"num": "XXXX1018593",

"status": "process", - статус слежения

"do1": 0, - сколько записей ДО1 по контейнеру

"cmn13014": 0, - сколько сообщений 13014 по контейнеру

"infoDateMax": null, - максимальная дата полученная из сообщений

},

………..

]

}

<big>Метод</big> '''<big>Set</big>'''

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|-
|add
|[]
|Массив успешно добавленных контейнеров
|-
|no
|[]
|Массив контейнеров, которые не добавлены. Каждый элемент содержит массив, состоящий из номера контейнера и статуса
|}

<big>Пример ответа:</big>

{

"add": ["TEST0000001"],

"success": true,

"no": [

[ "TEST0000002", "Новый" ]

]

}

<big>Метод</big> '''<big>Del</big>'''
аналогичен методу set

POST данные: data=TEST0000001,TEST0000002

Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|}

<big>Пример ответа:</big>

{

"success": true

}

<big>Метод</big> '''<big>Info</big>'''
Описание полей возвращаемых данных

{| class="wikitable"
|success
|bol
|true ― успешный запрос
|-
|data
|[]
|Массив, содержащий настройки аккаунта
|-
|notifyEmail
|bool
|1 ― включены уведомления на email
|-
|notifyOneMail
|bool
|1 ― отдельное письмо для каждого результата. Если в течении минуты пришло несколько контейнеров, то при значении "0" они будут объединены в одно письмо
|-
|notifyTG
|bool
|1 ― включены уведомления в телеграмм
|-
|notifyWebhook
|bool
|1 ― включены уведомления webhook
|-
|webhook
|str
|URL-адрес webhook
|-
|tgId
|int
|ID привязанного телеграмм аккаунта
|-
|sa_balance
|float
|Баланс сервис аккаунта
|-
|service_price
|float
|Цена за уведомление
|-
|freezing
|float
|Заморожено средств
|-
|addArh
|bool
|Разрешено добавлять архивные
|-
|sa_login
|str
|Логин выбранного сервис аккаунта
|-
|notifyAddDoc
|bool
|1 ― добавляет номер документа-основания (ДО1 или CMN.13014) в текст уведомления
|-
|notifyOldDay
|int
|Кол-во дней. При постановке задачи на слежение учитывается полученная ранее информация. Если параметр = 3 дня, то будет уведомление об информации не старше 3 дней. Влияет только на начало слежения
|-
|notifyLoginEmail
|bool
|Уведомление на email аккаунта
|-
|notify13014
|bool
|Уведомлять о получении сообщений 13014
|-
|notifyDO1
|bool
|Уведомлять о появлении новых ДО1
|-
|login
|str
|Ваш логин
|-
|emails
|[]
|Массив Ваших дополнительных email адресов для уведомлений. Содержит массив значений ― email адрес (ключевое поле) и состояние - включен (true) или нет (false)
|}

<big>Пример ответа:</big>

{

"data": {

"notifyEmail": 0,

"service_price": 1,

"notifyAddDoc": 1,

"notifyTG": 0,

"freezing": 147,

"notifyWebhook": 0,

"webhook": null,

"addArh": 0,

"sa_login": "сервис аккаунт",

"notifyDO1": 0,

"tgId": 11122233344,

"sa_balance": 500,

"notifyOldDay": 3,

"notifyLoginEmail": 0,

"notify13014": 1,

"notifyOneMail": 0,

"login": "ваш логин",

"emails": {

"первый@": false,

"второй@": true

},

},

"success": true

}

'''<big>Webhook</big>'''

По Webhook на указанный в личном кабинете URL-адрес приходят POST данные в таком формате:
{| class="wikitable"
|test
|int
|1 ― указывает что запрос тестовый, отсутствие параметра ― боевой
|-
|change
|[] json
|Массив изменений в json формате
|-
|Номер контейнера : тип уведомления
|
|Тип уведомления: do1 ― появилась ДО1; 13014 ― появилось сообщение CMN.13014
|}
пример POST запроса:

test=1&change={"TEST0000001":"do1","TEST0000002":"13014"}

=== Возможные ошибки ===
При возникновении ошибок возвращается код ответа сервера отличный от '''200''', а также описание ошибки в JSON-массиве.

код ответа '''400''':

{"success":false,"info":"Нет авторизации","code":101}

API Слежение (для Груз на СВХ)

2024-11-06T11:41:58Z

Ivakin: /* Формирование URL запроса */

== О сервисе Слежение ==
Сервис "Слежение" для "Груз на СВХ" <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki> позволяет ставить контейнеры на слежение с получением результатов размещения на складе и таможенного оформления грузов в контейнере через личный кабинет.

Отправляет уведомления на почту и URL-адрес по webhook о появлении новой информации по указанным контейнерам. Ставить и снимать контейнеры со слежения можно как через личный кабинет так и по API. Почта, URL-адрес для уведомлений и события для уведомления настраиваются только через личный кабинет.

== API ==
Доступ к API предоставляется по URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki>. Для использования сервиса необходима авторизация с помощью логина и пароля.

Логин и пароль для обращения по API необходимо получить в личном кабинете <nowiki>https://www.alta.ru/user/</nowiki>, заключив договор на использование онлайн-сервисов. В настройках договора будут указаны технический логин и пароль.

Тарификация производится так же как при постановке на слежение через личный кабинет.

API позволяет ставить, снимать со слежения и просматривать списки контейнеров находящихся на слежении. Уведомления об обнаружении новой информации приходят на указанные почтовые ящики в кабинете слежения <nowiki>https://www.alta.ru/svh-gruz/tracking/</nowiki>

=== Формирование URL запроса ===
Запросы направляются на URL <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/</nowiki><МЕТОД>/
{| class="wikitable"
|Метод
|Тип запроса
|Описание
|-
|help
|GET
|Вызывает справку - выдает доступные методы API и списки передаваемых параметров
|-
|test
|GET
|Проверка работы API и правильности формирования запроса - выдает результат проверки правильности секрета, правильную строку для расчета секрета и логин (если отправлен верный секрет)
|-
|info
|GET
|Информация об аккаунте и настройках слежения
|-
|set
|POST
|Постановка контейнеров на слежение, POST-параметр data=<номера контейнеров / авианакладных через запятую “,”>
|-
|del
|POST
|Снятие контейнеров со слежения, POST-параметр ids=<id контейнеров / авианакладных через запятую “,”> или data=<имена контейнеров / авианакладных через запятую “,”> (id контейнера приходит при постановке на слежение)
|-
|list
|GET
|Просмотр статуса всех отслеживаемых контейнеров. Через этот метод можно узнать id контейнеров находящихся на слежении. Можно указать нужные контейнеры: ids=<id контейнеров через запятую “,”> или data=<имена контейнеров через запятую “,”>
|}
обязательные GET параметры в URL

# логин ― логин сервис аккаунта в открытом виде
# секрет ― MD5-хеш от сгенерированной строки (все параметры разделены знаком “:” (двоеточие)): параметры_GET + параметры_POST + метод + логин + md5(пароль)

Формирование секрета

secret = md5("{параметры_GET}:{параметры_POST}:{метод}:{логин}:{md5(пароль)}")

параметры_GET ― это значения прочих get параметров помимо логина, секрета и метода, разделенные “:”

параметры_POST ― это значения post параметров для методов set и del, разделенные “:”

Пример расчёта секрета для метода del, логина testlogin и пароля testpassword:

Если дополнительный GET параметр foo = bar , то для расчета секрета надо использовать параметры_GET = “bar”

Для метода del надо указывать id номера контейнеров в POST параметре ids через запятую. Если ids=11,55,33 , то для расчета секрета параметры_POST = “11,55,33”

Итоговая строка секрета = md5("bar:11,55,33:del:testlogin:md5(testpassword)")

Пример запроса списка контейнеров:

Метод list, пользователь с логином testlogin и пароль testpassword

Прочие параметры_GET - отсутствуют, параметры_POST отсутствуют, так как это GET метод

Вычисляем секрет: secret = md5("пусто:пусто:list:testlogin:md5(testpassword)") = md5("::list:testlogin:md5(testpassword)") = 18a3a18768475d5fbaf244f291212e86

Таким образом, итоговый URL, на который совершается GET-запрос: <nowiki>https://www.alta.ru/svh-gruz/tracking/api/v1/list/?login=testlogin&secret=18a3a18768475d5fbaf244f291212e86</nowiki>

=== Ответ ===

<big>Метод</big> '''<big>List</big>'''
Описание полей возвращаемых данных
{| class="wikitable"
|data
|[]
|Корневой элемент, содержит массив записей слежения *
|-
|id
|int
|Идентификатор записи слежения
|-
|created
|str
|Дата постановки на слежение 3
|-
|updated
|str
|Дата последнего обновления информации сервисом
|-
|num
|str
|Номер контейнера
|-
|status
|str
|Статус слежения 1
|-
|do1
|int
|Количество записей ДО1 по контейнеру
|-
|cmn13014
|int
|Количество сообщений 13014 по контейнеру
|-
|infoDateMax
|str
|Дата последних полученных данных по контейнеру
|}
<nowiki>*</nowiki> максимальный размер возвращаемых данных 9900 записей

1 Статусы слежения:
{| class="wikitable"
|new
|Новый, запись только что добавлена
|-
|process
|В процессе обработки, проходят проверки
|-
|old
|В процессе обработки, имеется старая информация, старше чем указано в настройках ЛК в параметре Уведомлять о старой информации 2
|-
|busy
|Занят, происходит запись информации
|-
|arh
|Контейнер перенесен в архив (удален), автоматически помещается в архив если статус old более 90 дней
|}

2 Уведомлять о старой информации ― Параметр включает уведомления по событиям слежения с даты ранее даты постановки на слежение created 3

Например, если в параметре установлено 3 дня, то при постановке контейнера на слежение он уведомит Вас об информации, которая появилась не старше чем 3 дня назад.

<big>Пример ответа:</big>

Код ответа 200:

{

"data": [

{

"id": 12,

"created": "2023-01-19 12:03:45",

"updated": "2023-04-11 18:11:06",

"num": "XXXX1018593",

"status": "process", - статус слежения

"do1": 0, - сколько записей ДО1 по контейнеру

"cmn13014": 0, - сколько сообщений 13014 по контейнеру

"infoDateMax": null, - максимальная дата полученная из сообщений

},

………..

]

}

<big>Метод</big> '''<big>Set</big>'''
Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|-
|add
|[]
|Массив успешно добавленных контейнеров
|-
|no
|[]
|Массив контейнеров, которые не добавлены. Каждый элемент содержит массив, состоящий из номера контейнера и статуса
|}

<big>Пример ответа:</big>

{

"add": ["TEST0000001"],

"success": true,

"no": [

[ "TEST0000002", "Новый" ]

]

}

<big>Метод</big> '''<big>Del</big>'''
Описание полей возвращаемых данных
{| class="wikitable"
|success
|bool
|true ― успешный запрос
|}

<big>Пример ответа:</big>

{

"success": true

}

<big>Метод</big> '''<big>Info</big>'''
Описание полей возвращаемых данных

{| class="wikitable"
|success
|bol
|true ― успешный запрос
|-
|data
|[]
|Массив, содержащий настройки аккаунта
|-
|notifyEmail
|bool
|1 ― включены уведомления на email
|-
|notifyOneMail
|bool
|1 ― отдельное письмо для каждого результата. Если в течении минуты пришло несколько контейнеров, то при значении "0" они будут объединены в одно письмо
|-
|notifyTG
|bool
|1 ― включены уведомления в телеграмм
|-
|notifyWebhook
|bool
|1 ― включены уведомления webhook
|-
|webhook
|str
|URL-адрес webhook
|-
|tgId
|int
|ID привязанного телеграмм аккаунта
|-
|sa_balance
|float
|Баланс сервис аккаунта
|-
|service_price
|float
|Цена за уведомление
|-
|freezing
|float
|Заморожено средств
|-
|addArh
|bool
|Разрешено добавлять архивные
|-
|sa_login
|str
|Логин выбранного сервис аккаунта
|-
|notifyAddDoc
|bool
|1 ― добавляет номер документа-основания (ДО1 или CMN.13014) в текст уведомления
|-
|notifyOldDay
|int
|Кол-во дней. При постановке задачи на слежение учитывается полученная ранее информация. Если параметр = 3 дня, то будет уведомление об информации не старше 3 дней. Влияет только на начало слежения
|-
|notifyLoginEmail
|bool
|Уведомление на email аккаунта
|-
|notify13014
|bool
|Уведомлять о получении сообщений 13014
|-
|notifyDO1
|bool
|Уведомлять о появлении новых ДО1
|-
|login
|str
|Ваш логин
|-
|emails
|[]
|Массив Ваших дополнительных email адресов для уведомлений. Содержит массив значений ― email адрес (ключевое поле) и состояние - включен (true) или нет (false)
|}

<big>Пример ответа:</big>

{

"data": {

"notifyEmail": 0,

"service_price": 1,

"notifyAddDoc": 1,

"notifyTG": 0,

"freezing": 147,

"notifyWebhook": 0,

"webhook": null,

"addArh": 0,

"sa_login": "сервис аккаунт",

"notifyDO1": 0,

"tgId": 11122233344,

"sa_balance": 500,

"notifyOldDay": 3,

"notifyLoginEmail": 0,

"notify13014": 1,

"notifyOneMail": 0,

"login": "ваш логин",

"emails": {

"первый@": false,

"второй@": true

},

},

"success": true

}

'''<big>Webhook</big>'''

По Webhook на указанный в личном кабинете URL-адрес приходят POST данные в таком формате:
{| class="wikitable"
|test
|int
|1 ― указывает что запрос тестовый, отсутствие параметра ― боевой
|-
|change
|[] json
|Массив изменений в json формате
|-
|Номер контейнера : тип уведомления
|
|Тип уведомления: do1 ― появилась ДО1; 13014 ― появилось сообщение CMN.13014
|}
пример POST запроса:

test=1&change={"TEST0000001":"do1","TEST0000002":"13014"}

=== Возможные ошибки ===
При возникновении ошибок возвращается код ответа сервера отличный от '''200''', а также описание ошибки в JSON-массиве.

код ответа '''400''':

{"success":false,"info":"Нет авторизации","code":101}