Skip to content
Мои токены Поддержка
Чат для вопросов по API Мгновенно ответим на ваши вопросы
api@ati.su Электронная почта техподдержки
Тикетная система Оставить заявку на отдел "Консультанты по интеграции (API)"
api.ati.su - заказы, торги, площадки Наш телеграм-канал
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя
Отменить

API электронной транспортной накладной (ЭТрН)

Последовательность вызовов для создания и отправки первого титула (титула грузоотправителя) ЭТрН

  1. Создание ЭТрН
  2. Сохранение данных первого титула (титула грузоотправителя)
  3. Сохранение участников
  4. Формирование XML-файла первого титула (титула грузоотправителя)
  5. Отправка первого титула (титула грузоотправителя)

Последовательность вызовов для создания и отправки второго титула (титула перевозчика) ЭТрН

  1. Сохранение данных второго титула (титула перевозчика)
  2. Формирование XML-файла второго титула (титула перевозчика)
  3. Отправка второго титула (титула перевозчика)

Последовательность вызовов для создания и отправки третьего титула (титула грузополучателя) ЭТрН

  1. Сохранение данных третьего титула (титула грузополучателя)
  2. Формирование XML-файла третьего титула (титула грузополучателя)
  3. Отправка третьего титула (титула грузополучателя)

Последовательность вызовов для создания и отправки четвёртого титула (титула перевозчика) ЭТрН

  1. Сохранение данных четвёртого титула (титула перевозчика)
  2. Формирование XML-файла четвёртого титула (титула перевозчика)
  3. Отправка четвёртого титула (титула перевозчика)

Получение информации по ЭТрН

  1. Получение информации по участнику документооборота
  2. Получение метаинформации по ЭТрН (подписанты, статус и т.д.)
  3. Получение ключа доступа к печатной форме и QR-коду
  4. Скачивание файла печатной формы и QR-кода

Работа с первым титулом (титулом грузоотправителя) ЭТрН

Создание ЭТрН

Позволяет создать пустой первый титул ЭТрН с данными грузоотправителя. С этого момента можно получать метаинформацию по документу.

Создание ЭТрН
post /gw/epd/etrn/v1/docflows
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Successful Response
Модель
{...}

Возвращает id документооборота

id*: string
}
Пример
{...}
"id":"string"
}

Сохранение черновика первого титула (титула грузоотправителя). JSON

Позволяет сохранить данные первого титула. В теле передаётся JSON в утверждённом законодательством формате. Параметр send_to_driver отвечает за отправку ЭТрН в приложение «АТИ Водитель» после успешного подписания первого титула.

Сохранение черновика первого титула
put /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1
Запрос
Модель
{...}
верс_форм: enum
[5.01]
ид_пол_иной: [string]
От (4 до 46 символов)
}
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"верс_форм":"5.01","ид_пол_иной":["string"],"документ":{"кнд":"1110339","наим_эк_суб_сост":"string","осн_дов_орг_сост":"?","сод_инф_го":"?"}}'
Ответ
200 Successful Response
Модель
{...}

Возвращает id документооборота

id*: string
}
Пример
{...}
"id":"string"
}
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Сохранение участников ЭТрН

Сохраняет участников (подписантов) ЭТрН.

Сохранение участников ЭТрН
put /gw/epd/etrn/v1/docflows/{docflow_id}/participants
Запрос
Модель
{...}
}
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/participants' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"cargo_carrier":{"firm_id":"[0-9]+","contact_id":0,"user_astral_id":"string"},"cargo_receiver":{"firm_id":"[0-9]+","contact_id":0,"user_astral_id":"string"}}'
Ответ
200 Successful Response
Модель
{...}

Возвращает id документооборота

id*: string
}
Пример
{...}
"id":"string"
}
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Формирование первого титула (титула грузоотправителя). XML-файл

Позволяет создать XML-файл первого титула, чтобы в дальнейшем подписать и отправить его. Указывается отпечаток сертификата электронной подписи SHA-1 и номер МЧД (если есть).

Генерация первого титула (XML-файл)
post /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1/xml
Запрос
Модель
{...}

Схема тела запроса для генерации xml, необходимая для генерации полномочий подписанта

certificate_id*: string

Идентификатор сертификата

power_of_attorney_id: string

Идентификатор МЧД

}
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1/xml' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"certificate_id":"string","power_of_attorney_id":"string"}'
Ответ
200 Successful Response
Модель
null
Пример
null
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Отправка первого титула (титула грузоотправителя)

Позволяет отправить первый титул в ГИС (в Государственную информационную систему) и контрагентам. После отправки титула в ГИС, ЭТрН меняет свой статус на “title_1_waiting_operator”. После получения первого титула ГИС проводит валидацию титула:

  • если валидация пройдена успешно — титул поступает контрагентам, а статус ЭТрН меняется на “title_1_success”;
  • если валидация не пройдена — статус ЭТрН меняется вновь на “draft” и первый титул контрагентам не поступает. При отправке необходимо указать строку подписи прикладываемого XML-файла первого титула в формате base64.
Отправка первого титула
post /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1/send
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1/send' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'
Ответ
200 Successful Response
Модель
{...}

Возвращает id документооборота

id*: string
}
Пример
{...}
"id":"string"
}
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Работа со вторым титулом ЭТрН (титулом перевозчика)

Сохранение черновика второго титула (титула перевозчика). JSON

Позволяет сохранить данные второго титула. В теле передаётся JSON в утверждённом законодательством формате.

Сохранение черновика второго титула
put /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2
Запрос
Модель
{...}
верс_форм: enum
[5.01]
ид_пол_иной: [string]
От (4 до 46 символов)
}
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"верс_форм":"5.01","ид_пол_иной":["string"],"документ":{"кнд":"1110340","сод_инф_прв_прием":{"зам_прв_прием":{"зам_дат_вр_приб":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_прб":"0","зам_дат_вр_убыт":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_уб":"0","зам_дат_вр_пос_прием":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_прм":"0","зам_сост_груз":"string","зам_масс":"string","зам_кол_мест":"string","зам_погр_раб":"string","инф_пол":[{"ид_файл_инф_пол":"string","текст_инф":[{"идентиф":"string","значение":"string"}]}]},"отмет_прв_прием":[{"дат_вр_отмет":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_отм":"0","обст_отмет":"string","отм_акт_взв":"string","св_акт":[{"наим_док":"string","номер_док":"string","дата_док":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})","ид_док":"string","доп_свед_док":"string","ид_рек_сост":[{"иннюл":"([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}","иннфл":"([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}","данн_ино":{"ид_стат":"ЮЛ","стран":"string","наим":"string","идентиф":"string","иные_свед":"string","уд_личн_ин_фл":{"вид_док":"string","ном_док":"string","дата_док":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"}},"наим_оив":"string"}]}],"разм_штр":[{"факт_кол_ед_изм":"string","итог_разм_штр_рф":0.5,"код_окв":"[0-9]{3}","наим_окв":"string","итог_разм_штр_ин":0.5,"дата_курс_вал":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})","курс_вал":0.5,"расч_штр":"string"}],"инф_пол":[{"ид_файл_инф_пол":"string","текст_инф":[{"идентиф":"string","значение":"string"}]}]}],"инф_пол":[{"ид_файл_инф_пол":"string","текст_инф":[{"идентиф":"string","значение":"string"}]}]}}}'
Ответ
200 Successful Response
Модель
{...}

Возвращает id документооборота

id*: string
}
Пример
{...}
"id":"string"
}
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Формирование второго титула (титула перевозчика). XML-файл

Позволяет создать XML-файл второго титула, чтобы в дальнейшем подписать и отправить его. Указывается отпечаток сертификата электронной подписи SHA-1 и номер МЧД (если есть).

Генерация второго титула (XML-файл)
post /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2/xml
Запрос
Модель
{...}

Схема тела запроса для генерации xml, необходимая для генерации полномочий подписанта

certificate_id*: string

Идентификатор сертификата

power_of_attorney_id: string

Идентификатор МЧД

}
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2/xml' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"certificate_id":"string","power_of_attorney_id":"string"}'
Ответ
200 Successful Response
Модель
null
Пример
null
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Отправка второго титула (титула перевозчика)

Позволяет отправить второй титул ЭТрН в ГИС (в Государственную информационную систему) и контрагентам. После отправки титула в ГИС, ЭТрН меняет свой статус на “title_2_waiting_operator”. После получения второго титула ГИС проводит валидацию титула:

  • если валидация пройдена успешно — титул поступает контрагентам, статус ЭТрН меняется на “title_2_success”;
  • если валидация не пройдена — статус ЭТрН меняется вновь на “title_1_success” и второй титул контрагентам не поступает. При отправке необходимо указать строку подписи прикладываемого XML-файла второго титула в формате base64.
Отправка второго титула
post /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2/send
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2/send' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'
Ответ
200 Successful Response
Модель
{...}

Возвращает id документооборота

id*: string
}
Пример
{...}
"id":"string"
}
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Работа с третьим титулом ЭТрН (титулом грузополучателя)

Сохранение черновика третьего титула (титула грузополучателя). JSON

Позволяет сохранить данные третьего титула. В теле передаётся JSON в утверждённом законодательством формате.

Сохранение черновика третьего титула
put /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3
Запрос
Модель
{...}
верс_форм: enum
[5.01]
ид_пол_иной: [string]
От (4 до 46 символов)
}
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"верс_форм":"5.01","ид_пол_иной":["string"],"документ":{"кнд":"1110341","наим_экон_суб_сост":"string","осн_довер_орг_сост":{"наим_док":"string","номер_док":"string","дата_док":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})","ид_док":"string","доп_свед_док":"string","ид_рек_сост":[{"иннюл":"([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}","иннфл":"([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}","данн_ино":{"ид_стат":"ЮЛ","стран":"string","наим":"string","идентиф":"string","иные_свед":"string","уд_личн_ин_фл":{"вид_док":"string","ном_док":"string","дата_док":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"}},"наим_оив":"string"}]},"сод_инф_гп":{"сод_оп_отк":"string","прич_отк":"string","испр_тр_н":{"ном_испр":0.5,"дата_испр":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"},"прием_груз_гп":{"ф_дат_вр_приб":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_ф_пр":"0","ф_дат_вр_убыт":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_ф_уб":"0","заяв_дат_вр_приб":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_з_пр":"0","мет_опр_масс":"01","кол_мест_прием_ч":0.5,"общ_св_сост":"string","мас_брут_знач_прием":0.5,"мас_нет_знач_прием":0.5,"объем":0.5,"адр_выгруз":{"адр_коммент":"string","глн":"string","коорд":{"широта":"string","долгота":"string"},"адрес_рф":{"индекс":"string","код_регион":"[0-9]{2}","район":"string","город":"string","насел_пункт":"string","улица":"string","дом":"string","корпус":"string","кварт":"string"},"адрес_инф":{"код_стр":"[0-9]{3}","адр_текст":"string"},"код_гар":"string"},"св_прин_по_наим":[{"наим_груз":"string","сост_груз":"string","плотн":0.5,"объем":0.5,"кол_мест":0.5,"пер_марк":["string"],"мас_груз":{"мас_нет_знач":0.5,"мас_брут_знач":0.5,"кол_палл":0.5}}],"инф_пол":[{"ид_файл_инф_пол":"string","текст_инф":[{"идентиф":"string","значение":"string"}]}]},"отмет_гп":[{"дат_вр_отмет":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_отм":"0","обст_отмет":"string","св_акт":[{"наим_док":"string","номер_док":"string","дата_док":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})","ид_док":"string","доп_свед_док":"string","ид_рек_сост":[{"иннюл":"([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}","иннфл":"([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}","данн_ино":{"ид_стат":"ЮЛ","стран":"string","наим":"string","идентиф":"string","иные_свед":"string","уд_личн_ин_фл":{"вид_док":"string","ном_док":"string","дата_док":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"}},"наим_оив":"string"}]}],"разм_штр":[{"факт_кол_ед_изм":"string","итог_разм_штр_рф":0.5,"код_окв":"[0-9]{3}","наим_окв":"string","итог_разм_штр_ин":0.5,"дата_курс_вал":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})","курс_вал":0.5,"расч_штр":"string"}],"св_акт_взв":[{"наим_док":"string","номер_док":"string","дата_док":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})","ид_док":"string","доп_свед_док":"string","ид_рек_сост":[{"иннюл":"([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}","иннфл":"([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}","данн_ино":{"ид_стат":"ЮЛ","стран":"string","наим":"string","идентиф":"string","иные_свед":"string","уд_личн_ин_фл":{"вид_док":"string","ном_док":"string","дата_док":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"}},"наим_оив":"string"}]}],"инф_пол":[{"ид_файл_инф_пол":"string","текст_инф":[{"идентиф":"string","значение":"string"}]}]}],"инф_пол":[{"ид_файл_инф_пол":"string","текст_инф":[{"идентиф":"string","значение":"string"}]}]}}}'
Ответ
200 Successful Response
Модель
{...}

Возвращает id документооборота

id*: string
}
Пример
{...}
"id":"string"
}
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Формирование третьего титула (титула грузополучателя). XML-файл

Позволяет создать XML-файл третьего титула, чтобы в дальнейшем подписать и отправить его. Указывается отпечаток сертификата электронной подписи SHA-1 и номер МЧД (если есть).

Генерация третьего титула (XML-файл)
post /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3/xml
Запрос
Модель
{...}

Схема тела запроса для генерации xml, необходимая для генерации полномочий подписанта

certificate_id*: string

Идентификатор сертификата

power_of_attorney_id: string

Идентификатор МЧД

}
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3/xml' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"certificate_id":"string","power_of_attorney_id":"string"}'
Ответ
200 Successful Response
Модель
null
Пример
null
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Отправка третьего титула (титула грузополучателя)

Позволяет отправить третий титул ЭТрН в ГИС (в Государственную информационную систему) и контрагентам. После отправки титула в ГИС, ЭТрН меняет свой статус на “title_3_waiting_operator”. После получения третьего титула ГИС проводит валидацию титула:

  • если валидация пройдена — титул поступает контрагентам, статус ЭТрН меняется на “title_3_success”;
  • если валидация не пройдена — статус ЭТрН меняется вновь на “title_2_success” и третий титул контрагентам не поступает. При отправке необходимо указать строку подписи прикладываемого XML-файла третьего титула в формате base64.
Отправка третьего титула
post /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3/send
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3/send' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'
Ответ
200 Successful Response
Модель
{...}

Возвращает id документооборота

id*: string
}
Пример
{...}
"id":"string"
}
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Работа с четвёртым титулом ЭТрН (титулом перевозчика)

Сохранение черновика четвёртого титула (титула перевозчика). JSON

Позволяет сохранить данные четвёртого титула. В теле передаётся JSON в утверждённом законодательством формате.

Сохранение черновика четвёртого титула
put /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4
Запрос
Модель
{...}
верс_форм: enum
[5.01]
ид_пол_иной: [string]
От (4 до 46 символов)
}
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"верс_форм":"5.01","ид_пол_иной":["string"],"документ":{"кнд":"1110342","сод_прв_выд":{"зам_прв_выд":{"зам_дата_вр_приб":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_пр":"0","зам_дат_вр_убыт":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_уб":"0","зам_дат_вр_пос_выгр":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_выгр":"0","зам_сост_груз":"string","зам_раб_выгр":"string","инф_пол":[{"ид_файл_инф_пол":"string","текст_инф":[{"идентиф":"string","значение":"string"}]}]},"отмет_прв_выд":[{"дат_вр_отмет":"(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))","нал_коор_точ_вр_отм":"0","обст_отмет":"string","отм_акт_взв":"string","св_акт":[{"наим_док":"string","номер_док":"string","дата_док":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})","ид_док":"string","доп_свед_док":"string","ид_рек_сост":[{"иннюл":"([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}","иннфл":"([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}","данн_ино":{"ид_стат":"ЮЛ","стран":"string","наим":"string","идентиф":"string","иные_свед":"string","уд_личн_ин_фл":{"вид_док":"string","ном_док":"string","дата_док":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"}},"наим_оив":"string"}]}],"разм_штр":[{"факт_кол_ед_изм":"string","итог_разм_штр_рф":0.5,"код_окв":"[0-9]{3}","наим_окв":"string","итог_разм_штр_ин":0.5,"дата_курс_вал":"(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})","курс_вал":0.5,"расч_штр":"string"}],"инф_пол":[{"ид_файл_инф_пол":"string","текст_инф":[{"идентиф":"string","значение":"string"}]}]}],"инф_пол":[{"ид_файл_инф_пол":"string","текст_инф":[{"идентиф":"string","значение":"string"}]}]}}}'
Ответ
200 Successful Response
Модель
{...}

Возвращает id документооборота

id*: string
}
Пример
{...}
"id":"string"
}
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Формирование четвёртого титула (титула перевозчика). XML-файл

Позволяет создать XML-файл четвёртого титула, чтобы в дальнейшем подписать и отправить его. Указывается отпечаток сертификата электронной подписи SHA-1 и номер МЧД (если есть).

Генерация четвёртого титула (XML-файл)
post /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4/xml
Запрос
Модель
{...}

Схема тела запроса для генерации xml, необходимая для генерации полномочий подписанта

certificate_id*: string

Идентификатор сертификата

power_of_attorney_id: string

Идентификатор МЧД

}
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4/xml' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"certificate_id":"string","power_of_attorney_id":"string"}'
Ответ
200 Successful Response
Модель
null
Пример
null
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Отправка четвёртого титула (титула перевозчика)

Позволяет отправить четвёртый титул ЭТрН в ГИС (в Государственную информационную систему) и контрагентам. После отправки титула в ГИС, ЭТрН меняет свой статус на “title_4_waiting_operator”. После получения четвёртого титула ГИС проводит валидацию титула:

  • если валидация пройдена успешно, то титул поступает контрагентам, статус ЭТрН меняется на “title_4_success”;
  • если валидация не пройдена — статус ЭТрН меняется вновь на “title_3_success” и четвёртый титул контрагентам не поступает. При отправке необходимо указывать строку подписи прикладываемого XML-файла четвёртого титула в формате base64.
Отправка четвёртого титула
post /gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4/send
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4/send' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'
Ответ
200 Successful Response
Модель
{...}

Возвращает id документооборота

id*: string
}
Пример
{...}
"id":"string"
}
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Получение информации по ЭТрН

Поиск участников документооборота по ИНН

Позволяет получить данные участника документооборота по ИНН. По умолчанию astral_stand = real. Для тестового стенда astral_stand = fake

Поиск участников по ИНН
get /gw/epd/users/v1/participants
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/epd/users/v1/participants' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Successful Response
Модель
[{...}]
astral_user_id*: string

Идентификатор astral_user

firm_id*: string

Идентификатор фирмы

name*: string

Наименование участника

account_id*: string

Идентификатор аккаунта АТИ

default_contact_id*: integer

Идентификатор контакта аккаунта по умолчанию

}]
Пример
[...]
{...}
"astral_user_id":"string",
"firm_id":"string",
"name":"string",
"account_id":"string",
"default_contact_id":0
}
]
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Получение метаинформации по ЭТрН

Позволяет получить метаинформацию по ЭТрН (подписанты, статус и т. д.).

Получение метаинформации по ЭТрН
get /gw/epd/etrn/v1/docflows/{docflow_id}
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Successful Response
Модель
{...}

Общая информация о документообороте

id*: string
state*: enum
[draft, title_1_accepted, title_1_waiting_operator, title_1_success, title_2_accepted, title_2_waiting_operator, title_2_success, title_3_accepted, title_3_waiting_operator, title_3_success, title_4_accepted, title_4_waiting_operator, title_4_success, title_7_requested, title_7_accepted, title_7_waiting_operator, title_7_success, title_8_accepted, title_8_waiting_operator, title_8_success, operator_failed]

Все возможные состояния для документооборота ЭТрН

flags*: [string]

Список флагов

number: string

Номер ЭТРН

date: string

Дата заполнения ЭТРН

astral_stand*: enum
[fake, real]

An enumeration.

template_name: string

Имя шаблона

}
Пример
{...}
"id":"string",
"state":"draft",
"participants":{...},
"cargo_sender":{...},
"inn":"string",
"first_name":"string",
"last_name":"string",
"patronymic":"string",
"full_name":"string",
"kpp":"string",
"ati_id":"string",
"default":false,
"is_roaming_user":false,
"id":"string",
"roaming_operator_id":"string",
"created_at":"1970-01-01T00:00:00.000Z",
"certificates":[...],
{...}
"id":"string",
"valid_from":"1970-01-01T00:00:00.000Z",
"valid_until":"1970-01-01T00:00:00.000Z",
"serial":"string",
"issuer":{...},
"OGRN":"string",
"INN":"string",
"CN":"string"
},
"components":{...},
"SNILS":"string",
"OGRN":"string",
"INN":"string",
"emailAddress":"string",
"C":"string",
"ST":"string",
"L":"string",
"O":"string",
"CN":"string",
"street":"string",
"unstructuredName":"string",
"title":"string",
"GN":"string",
"SN":"string"
},
"title":"string",
"body":"string",
"created_at":"1970-01-01T00:00:00.000Z"
}
],
"signatory_credentials":[...]
{...}
"scope_of_authority":{...},
"sender":"0",
"receiver":"1"
},
"status":"3",
"foundation_for_trust":"string",
"foundation_for_trust_organization":"string",
"position":"string",
"certificate_id":"string"
}
]
},
"cargo_carrier":{...},
"inn":"string",
"first_name":"string",
"last_name":"string",
"patronymic":"string",
"full_name":"string",
"kpp":"string",
"ati_id":"string",
"default":false,
"is_roaming_user":false,
"id":"string",
"roaming_operator_id":"string",
"created_at":"1970-01-01T00:00:00.000Z",
"certificates":[...],
{...}
"id":"string",
"valid_from":"1970-01-01T00:00:00.000Z",
"valid_until":"1970-01-01T00:00:00.000Z",
"serial":"string",
"issuer":{...},
"OGRN":"string",
"INN":"string",
"CN":"string"
},
"components":{...},
"SNILS":"string",
"OGRN":"string",
"INN":"string",
"emailAddress":"string",
"C":"string",
"ST":"string",
"L":"string",
"O":"string",
"CN":"string",
"street":"string",
"unstructuredName":"string",
"title":"string",
"GN":"string",
"SN":"string"
},
"title":"string",
"body":"string",
"created_at":"1970-01-01T00:00:00.000Z"
}
],
"signatory_credentials":[...]
{...}
"scope_of_authority":{...},
"sender":"0",
"receiver":"1"
},
"status":"3",
"foundation_for_trust":"string",
"foundation_for_trust_organization":"string",
"position":"string",
"certificate_id":"string"
}
]
},
"cargo_receiver":{...}
"inn":"string",
"first_name":"string",
"last_name":"string",
"patronymic":"string",
"full_name":"string",
"kpp":"string",
"ati_id":"string",
"default":false,
"is_roaming_user":false,
"id":"string",
"roaming_operator_id":"string",
"created_at":"1970-01-01T00:00:00.000Z",
"certificates":[...],
{...}
"id":"string",
"valid_from":"1970-01-01T00:00:00.000Z",
"valid_until":"1970-01-01T00:00:00.000Z",
"serial":"string",
"issuer":{...},
"OGRN":"string",
"INN":"string",
"CN":"string"
},
"components":{...},
"SNILS":"string",
"OGRN":"string",
"INN":"string",
"emailAddress":"string",
"C":"string",
"ST":"string",
"L":"string",
"O":"string",
"CN":"string",
"street":"string",
"unstructuredName":"string",
"title":"string",
"GN":"string",
"SN":"string"
},
"title":"string",
"body":"string",
"created_at":"1970-01-01T00:00:00.000Z"
}
],
"signatory_credentials":[...]
{...}
"scope_of_authority":{...},
"sender":"0",
"receiver":"1"
},
"status":"3",
"foundation_for_trust":"string",
"foundation_for_trust_organization":"string",
"position":"string",
"certificate_id":"string"
}
]
}
},
"flags":[...],
"string"
],
"history":[...],
{...}
"state":"string",
"ati_id":"string",
"contact_id":0,
"firm_name":"string",
"contact_name":"string",
"user_astral_id":"string",
"user_astral_name":"string",
"timestamp":"1970-01-01T00:00:00.000Z",
"sign_info":{...}
"title":"string",
"valid_from":"string",
"valid_until":"string",
"id":"string",
"components":{...}
"any-key":"string"
}
}
}
],
"driver_data":{...},
"phone":"^[0-9]{11,13}$",
"driver_decision":"accepted",
"decision_timestamp":"1970-01-01T00:00:00.000Z",
"rejection_reason":"string",
"send_in_title_1":true,
"is_sent_to_driver":false,
"loading_point":{...},
"arrival_timestamp":"1970-01-01T00:00:00.000Z",
"departure_timestamp":"1970-01-01T00:00:00.000Z",
"timestamp":"1970-01-01T00:00:00.000Z",
"notes":"string"
},
"unloading_point":{...}
"arrival_timestamp":"1970-01-01T00:00:00.000Z",
"departure_timestamp":"1970-01-01T00:00:00.000Z",
"timestamp":"1970-01-01T00:00:00.000Z",
"notes":"string"
}
},
"number":"string",
"date":"01.04.2023",
"payment_history":{...},
"title_1":[...],
{...}
"document_id":"string",
"is_completed":false
}
],
"title_2":[...],
{...}
"document_id":"string",
"is_completed":false
}
],
"title_3":[...],
{...}
"document_id":"string",
"is_completed":false
}
],
"title_4":[...],
{...}
"document_id":"string",
"is_completed":false
}
],
"title_5":[...],
{...}
"document_id":"string",
"is_completed":false
}
],
"title_6":[...],
{...}
"document_id":"string",
"is_completed":false
}
],
"title_7":[...],
{...}
"document_id":"string",
"is_completed":false
}
],
"title_8":[...]
{...}
"document_id":"string",
"is_completed":false
}
]
},
"astral_stand":"fake",
"template_name":"string"
}
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Получение ключа доступа к печатной форме и QR-коду

Позволяет получить ключ доступа, необходимый для скачивания файлов печатной формы и QR-кода. Если файл печатной формы или QR-кода ранее не генерировался, то для успешного ответа потребуется время — вызов метода надо будет повторить.

Получение ключа доступа для скачивания печатной формы и QR-кода
post /gw/epd/etrn/v1/docflows/{docflow_id}/files/{doc_type}
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/files/{doc_type}' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Successful Response
Модель
{...}

Возвращает id файла

id*: string
}
Пример
{...}
"id":"string"
}
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}

Скачивание файла печатной формы и QR-кода

Позволяет скачивать файлы печатной формы и QR-кода. Требуется ключ доступа из метода выше.

Скачивание файлов печатной формы и QR-кода
get /gw/epd/etrn/v1/docflows/{docflow_id}/files/{file_key}
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/epd/etrn/v1/docflows/{docflow_id}/files/{file_key}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Successful Response
Модель
{missing-type-info}
Пример
null
422 Validation Error
Модель
{...}
}
Пример
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}