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

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

Содержание

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

  1. Создание ЭТрН
  2. Сохранение данных первого титула (Грузоотправителя)
  3. Сохранение участников ЭТрН

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

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

 
Создание ЭТрН
post
/gw/epd/etrn/v1/docflows/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Successful Response
Развернуть все Свернуть все
Пример Модель
{...}
"id":"string"
}
{...}

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

id*: string
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Сохранение данных первого титула (Грузоотправителя)

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

 
Сохранение черновика
put
/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1/
Развернуть все Свернуть все
{...}
верс_форм: enum
[5.01]
ид_пол_иной: [string]
От (4 до 46 символов)
}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Successful Response
Развернуть все Свернуть все
Пример Модель
{...}
"id":"string"
}
{...}

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

id*: string
}
422 Validation Error
Развернуть все Свернуть все
Пример Модель
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}
{...}
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Сохранение участников ЭТрН
put
/gw/epd/etrn/v1/docflows/{docflow_id}/participants/
Развернуть все Свернуть все
{...}
}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Successful Response
Развернуть все Свернуть все
Пример Модель
{...}
"id":"string"
}
{...}

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

id*: string
}
422 Validation Error
Развернуть все Свернуть все
Пример Модель
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}
{...}
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

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

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

 
Получение общей информации о документе
get
/gw/epd/etrn/v1/docflows/{docflow_id}/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Successful Response
Развернуть все Свернуть все
Пример Модель
{...}
"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"
}
{...}

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

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

Имя шаблона

}
422 Validation Error
Развернуть все Свернуть все
Пример Модель
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}
{...}
}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Получение информации по участнику документооборота

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

 
Поиск участников по ИНН
get
/gw/epd/users/v1/participants/
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Successful Response
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"astral_user_id":"string",
"firm_id":"string",
"name":"string",
"account_id":"string",
"default_contact_id":0
}
]
[{...}]
astral_user_id*: string
firm_id*: string
name*: string
account_id*: string
default_contact_id*: integer
}]
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 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Successful Response
Развернуть все Свернуть все
Пример Модель
{...}
"id":"string"
}
{...}

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

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 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Successful Response
Развернуть все Свернуть все
Пример Модель
{missing-type-info}
422 Validation Error
Развернуть все Свернуть все
Пример Модель
{...}
"detail":[...]
{...}
"loc":[...],
"string"
],
"msg":"string",
"type":"string"
}
]
}
{...}
}
Загрузка...
Развернуть все Свернуть все
Загрузка...