Skip to content
Мои токены Поддержка
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя
For LLMs and AI agents: canonical Markdown source of this documentation page (plain-text .md — fetch this URL to use the page content in tools and RAG). For LLMs and AI agents: developers documentation index in llms.txt format — ordered list of key documentation URLs for the developers section.

Страхование грузов

Методы для работы со страховыми заявками страхования грузов

Получение заявки на страхование груза

Метод интеграционного API для страхования грузов. Возвращает полные данные заявки по её идентификатору. Операция доступна только страховой компании, которой назначена заявка: фирма из токена должна совпадать со страховщиком по заявке.

Возвращает заявку на страхование груза для интеграционного API.
get /integration/v1/cargo-insurances/{insuranceId}
Запрос
Пример запроса
curl 'https://api.ati.su/integration/v1/cargo-insurances/{insuranceId}' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 OK
Модель
{...}

Модель страхования грузов для интеграций

id: uuid

Идентификатор заявки

ati_id: string (nullable)

Код страхователя в АТИ

firm_name: string (nullable)

Наименование страхователя

account_inn: string (nullable)

Инн

change_date: date-time

Дата изменения заявки

status: enum
[Sent, InProgress, Insured, Withdrawn, Request, Deflected, Cancelled, Approved]

Статус заявки в интеграционном API.

  • Sent (Новая)
  • InProgress (Обрабатывается)
  • Insured (Застрахована)
  • Withdrawn (Отозвана)
  • Request (Запрос)
  • Deflected (Отклонена)
  • Cancelled (Аннулирована)
  • Approved (Одобрена)
status_change_date: date-time

Дата изменения статуса

start_date: date

Дата начала действия страховки

end_date: date

Дата окончания действия страховки

sum: double

Страховая сумма

tariff_sum: double (nullable)

Стоимость полиса

tariff: double (nullable)

Процент стоимости полиса от страховой суммы

franchise_sum: double (nullable)

Франшиза

franchise: double (nullable)

Франшиза в %

currency*: string (nullable)

Валюта заявки

policy_number: string (nullable)

Номер полиса

policy_file_name: string (nullable)

Имя файла полиса

policy_file_url: string (nullable)

Ссылка на файл с полисом страхования

policy_template_file_url: string (nullable)

Ссылка на шаблон файла с полисом страхования

price_in_policy: boolean

Цена в полисе

}
Пример
{...}
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ati_id":"123456",
"firm_name":"ООО Ромашка",
"account_inn":"7701234567",
"firm_requisites":{...},
"requisite_id":"123",
"legal_address":{...},
"address_id":"123456",
"formatted_text":"Россия, г. Москва, ул. Ленина, д. 1"
},
"post_address":{...},
"address_id":"123456",
"formatted_text":"Россия, г. Москва, ул. Ленина, д. 1"
},
"full_name":"ООО Ромашка",
"inn":"7701234567",
"ogrn":"1027700123456",
"kpp":"770101001",
"rs":"40702810900000000001",
"ks":"30101810400000000225",
"bik":"044525225",
"bank":"ПАО Сбербанк",
"okpo":"12345678",
"signees":[...]
{...}
"signee_id":123,
"requisite_id":1234,
"full_name":"Иванов Иван Иванович",
"position":"Директор",
"act_upon":"Устав"
}
]
},
"change_date":"2026-05-28T10:00:00",
"status":"Insured",
"status_change_date":"2026-05-28T11:00:00",
"start_date":"2026-06-01",
"end_date":"2026-12-31",
"sum":150000,
"tariff_sum":3500,
"tariff":2.33,
"franchise_sum":10000,
"franchise":5,
"currency":"RUB",
"policy_number":"POL-123456",
"policy_file_name":"policy.pdf",
"policy_file_url":"https://example.com/policy.pdf",
"policy_template_file_url":"https://example.com/policy-template.pdf",
"price_in_policy":true,
"cargo":{...},
"cargo_type_name":"Бытовая техника",
"cargo_name":"Холодильники",
"cargo_package_count":10,
"cargo_package_type_name":"Паллеты",
"cargo_weight":12000.5,
"cargo_attributes_description":"С хрупкими элементами",
"sealing_number":"PL-778899",
"is_groupage":false,
"cargo_volume":0,
"is_used":false,
"is_perishable":false,
"is_secured":false,
"is_fragile":false,
"adr":false,
"inc_load_unload":false,
"is_fraud_risk":false
},
"route_vehicle":{...},
"from_city":"Москва",
"to_city":"Санкт-Петербург",
"distance":700000,
"vehicle_number":"А123АА77",
"document_number_type":"CMR",
"document_number":"CMR-123456",
"truck_type":"Тягач",
"extra_points":[...],
{...}
"point_type":1,
"address":"Россия, г. Казань, ул. Кремлевская, д. 5",
"city_name":"Казань",
"city_id":0
}
],
"vehicle_passport_files":[...],
{...}
"name":"policy.pdf",
"url":"https://example.com/policy.pdf"
}
],
"driver_passport_files":[...],
{...}
"name":"policy.pdf",
"url":"https://example.com/policy.pdf"
}
],
"driver_license_files":[...]
{...}
"name":"policy.pdf",
"url":"https://example.com/policy.pdf"
}
]
},
"carrier":{...},
"carrier_inn":"7812345678",
"carrier_name":"ООО Перевозчик",
"carrier_address":"Россия, г. Санкт-Петербург, Невский пр., д. 1"
},
"beneficiary":{...},
"beneficiary_inn":"7701234567",
"beneficiary_name":"ООО Выгодоприобретатель",
"beneficiary_address":"Россия, г. Москва, ул. Пушкина, д. 10"
},
"contact":{...}
"id":12345,
"name":"Иван Иванов",
"phone":"+7 900 123-45-67",
"email":"ivan@example.com"
}
}
400 Неверные входные данные.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"invalid_input_data",
"reason":"Неверные входные данные."
}
401 Не авторизован
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"un_authorized",
"reason":"Не авторизован"
}
402 Метод доступен только платным пользователям.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"payment_required",
"reason":"Метод доступен только платным пользователям."
}
403 Отсутствует разрешение.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"forbidden",
"reason":"Отсутствует разрешение."
}
404 Ресурс не найден
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"not_found",
"reason":"Ресурс не найден"
}
500 Произошла ошибка во время выполнения запроса.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"internal_error",
"reason":"Произошла ошибка во время выполнения запроса."
}
504 Сервер не ответил во время.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"timeout",
"reason":"Сервер не ответил во время."
}

Поиск заявок на страхование грузов

Метод интеграционного API для страхования грузов. Возвращает список заявок на страхование грузов по параметрам фильтра из тела запроса. В выборку попадают только заявки страховой компании, от имени которой выполняется запрос.

Поиск заявок на страхование грузов для страховой компании.
post /integration/v1/cargo-insurances
Запрос
Модель
{...}

Тело поиска заявок на страхование грузов (интеграционный метод для страховых)

skip: int32

Сколько заявок пропустить

take: int32

Сколько заявок вернуть

firms: [int32]

Список firmId страхователей

status: enum
[Sent, InProgress, Insured, Withdrawn, Request, Deflected, Cancelled, Approved]

Статус заявки в интеграционном API.

  • Sent (Новая)
  • InProgress (Обрабатывается)
  • Insured (Застрахована)
  • Withdrawn (Отозвана)
  • Request (Запрос)
  • Deflected (Отклонена)
  • Cancelled (Аннулирована)
  • Approved (Одобрена)
from_add_date: date-time (nullable)

Дата начала периода по дате создания заявки

to_add_date: date-time (nullable)

Дата конца периода по дате создания заявки

}
Пример запроса
curl 'https://api.ati.su/integration/v1/cargo-insurances' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"skip":0,"take":10,"firms":[12325],"status":"Insured","from_add_date":"2026-05-28T10:00:00+00:00","to_add_date":"2026-05-29T10:00:00+00:00"}'
Ответ
200 OK
Модель
{...}

Список заявок на страхование грузов (интеграционный API)

total: int32

Общее количество заявок на страхование грузов, подходящих под фильтр.

}
Пример
{...}
"total":5,
"insurances":[...]
{...}
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ati_id":"123456",
"firm_name":"ООО Ромашка",
"account_inn":"7701234567",
"firm_requisites":{...},
"requisite_id":"123",
"legal_address":{...},
"address_id":"123456",
"formatted_text":"Россия, г. Москва, ул. Ленина, д. 1"
},
"post_address":{...},
"address_id":"123456",
"formatted_text":"Россия, г. Москва, ул. Ленина, д. 1"
},
"full_name":"ООО Ромашка",
"inn":"7701234567",
"ogrn":"1027700123456",
"kpp":"770101001",
"rs":"40702810900000000001",
"ks":"30101810400000000225",
"bik":"044525225",
"bank":"ПАО Сбербанк",
"okpo":"12345678",
"signees":[...]
{...}
"signee_id":123,
"requisite_id":1234,
"full_name":"Иванов Иван Иванович",
"position":"Директор",
"act_upon":"Устав"
}
]
},
"change_date":"2026-05-28T10:00:00",
"status":"Insured",
"status_change_date":"2026-05-28T11:00:00",
"start_date":"2026-06-01",
"end_date":"2026-12-31",
"sum":150000,
"tariff_sum":3500,
"tariff":2.33,
"franchise_sum":10000,
"franchise":5,
"currency":"RUB",
"policy_number":"POL-123456",
"policy_file_name":"policy.pdf",
"policy_file_url":"https://example.com/policy.pdf",
"policy_template_file_url":"https://example.com/policy-template.pdf",
"invoice_url":"https://example.com/invoice.pdf",
"payment_url":"https://example.com/payment",
"price_in_policy":true,
"client_payment_date":"2026-05-29T14:30:00",
"insurer_payment_date":"2026-06-02T09:15:00",
"deflected_notice_comment":"Недостаточно документов для оформления полиса",
"cargo":{...},
"cargo_type_name":"Бытовая техника",
"cargo_name":"Холодильники",
"cargo_package_count":10,
"cargo_package_type_name":"Паллеты",
"cargo_weight":12000.5,
"cargo_attributes_description":"С хрупкими элементами",
"sealing_number":"PL-778899",
"is_groupage":false,
"cargo_volume":0,
"is_used":false,
"is_perishable":false,
"is_secured":false,
"is_fragile":false,
"adr":false,
"inc_load_unload":false,
"is_fraud_risk":false
},
"route_vehicle":{...},
"from_city":"Москва",
"to_city":"Санкт-Петербург",
"distance":700000,
"vehicle_number":"А123АА77",
"document_number_type":"CMR",
"document_number":"CMR-123456",
"truck_type":"Тягач",
"extra_points":[...],
{...}
"point_type":1,
"address":"Россия, г. Казань, ул. Кремлевская, д. 5",
"city_name":"Казань",
"city_id":0
}
],
"vehicle_passport_files":[...],
{...}
"name":"policy.pdf",
"url":"https://example.com/policy.pdf"
}
],
"driver_passport_files":[...],
{...}
"name":"policy.pdf",
"url":"https://example.com/policy.pdf"
}
],
"driver_license_files":[...]
{...}
"name":"policy.pdf",
"url":"https://example.com/policy.pdf"
}
]
},
"carrier":{...},
"carrier_inn":"7812345678",
"carrier_name":"ООО Перевозчик",
"carrier_address":"Россия, г. Санкт-Петербург, Невский пр., д. 1"
},
"beneficiary":{...},
"beneficiary_inn":"7701234567",
"beneficiary_name":"ООО Выгодоприобретатель",
"beneficiary_address":"Россия, г. Москва, ул. Пушкина, д. 10"
},
"contact":{...}
"id":12345,
"name":"Иван Иванов",
"phone":"+7 900 123-45-67",
"email":"ivan@example.com"
}
}
]
}
400 Неверные входные данные.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"invalid_input_data",
"reason":"Неверные входные данные."
}
401 Не авторизован
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"un_authorized",
"reason":"Не авторизован"
}
402 Метод доступен только платным пользователям.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"payment_required",
"reason":"Метод доступен только платным пользователям."
}
403 Отсутствует разрешение.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"forbidden",
"reason":"Отсутствует разрешение."
}
404 Ресурс не найден
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"not_found",
"reason":"Ресурс не найден"
}
500 Произошла ошибка во время выполнения запроса.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"internal_error",
"reason":"Произошла ошибка во время выполнения запроса."
}
504 Сервер не ответил во время.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"timeout",
"reason":"Сервер не ответил во время."
}

Перевод заявки в обработку

Метод интеграционного API для страхования грузов. Переводит заявку в статус «Обрабатывается». Выполнить операцию может только страховая компания, которой назначена заявка. Доступно для статусов: “новая” и “одобрена”. Если текущий статус заявки не позволяет перевести её в обработку, вернётся ошибка валидации.

Переводит заявку страхователя из статуса «Новая» или "Одобрена" в «Обрабатывается» по интеграционному API.
post /integration/v1/cargo-insurances/{insuranceId}/process
Запрос
Пример запроса
curl 'https://api.ati.su/integration/v1/cargo-insurances/{insuranceId}/process' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 OK
Модель
{...}

Краткий результат операции над заявкой в интеграционном API (идентификатор, статус и дата смены статуса).

id: uuid

Идентификатор заявки.

status: enum
[Sent, InProgress, Insured, Withdrawn, Request, Deflected, Cancelled, Approved]

Статус заявки в интеграционном API.

  • Sent (Новая)
  • InProgress (Обрабатывается)
  • Insured (Застрахована)
  • Withdrawn (Отозвана)
  • Request (Запрос)
  • Deflected (Отклонена)
  • Cancelled (Аннулирована)
  • Approved (Одобрена)
status_change_date: date-time

Дата и время последнего изменения статуса заявки.

deflected_notice_comment: string (nullable)

Текст причины отклонения для страхователя (если заявка отклонена).

}
Пример
{...}
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status":"Insured",
"status_change_date":"2026-05-28T10:00:00+00:00",
"deflected_notice_comment":"Недостаточно документов"
}
400 Неверные входные данные.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"invalid_input_data",
"reason":"Неверные входные данные."
}
401 Не авторизован
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"un_authorized",
"reason":"Не авторизован"
}
402 Метод доступен только платным пользователям.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"payment_required",
"reason":"Метод доступен только платным пользователям."
}
403 Отсутствует разрешение.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"forbidden",
"reason":"Отсутствует разрешение."
}
404 Ресурс не найден
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"not_found",
"reason":"Ресурс не найден"
}
500 Произошла ошибка во время выполнения запроса.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"internal_error",
"reason":"Произошла ошибка во время выполнения запроса."
}
504 Сервер не ответил во время.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"timeout",
"reason":"Сервер не ответил во время."
}

Прикрепление полиса к заявке на страхование груза

Метод интеграционного API для страхования грузов. Прикрепляет подписанный файл страхового полиса к заявке и подтверждает оплату клиента. После успешной загрузки рассчитывается кешбэк, заполняется дата оплаты клиента. Операция доступна только страховой компании, которой назначена заявка. Полис можно прикрепить из статусов «новая», «обрабатывается», «одобрена», а также из статуса «застрахована», если оплата клиента ещё не подтверждена. Тело запроса передаётся в формате multipart/form-data.

Прикрепляет файл полиса к заявке страхования груза в интеграционном API и подтверждает оплату клиента.
post /integration/v1/cargo-insurances/{insuranceId}/policy
Запрос
Модель
{...}
file*: binary

Файл полиса.

policy_number*: string

Номер полиса.

cargo_cost*: double

Стоимость груза.

policy_tariff*: double

Тариф полиса в процентах.

contact_id*: int32

Идентификатор основного контакта страховой компании.

additional_contact_id: int32

Идентификатор дополнительного контакта страховой компании.

}
Пример запроса
curl 'https://api.ati.su/integration/v1/cargo-insurances/{insuranceId}/policy' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@{file}' \
-F 'policy_number={policy_number}' \
-F 'cargo_cost={cargo_cost}' \
-F 'policy_tariff={policy_tariff}' \
-F 'contact_id={contact_id}' \
-F 'additional_contact_id={additional_contact_id}'
Ответ
200 OK
Успешный ответ
400 Неверные входные данные.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"invalid_input_data",
"reason":"Неверные входные данные."
}
401 Не авторизован
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"un_authorized",
"reason":"Не авторизован"
}
402 Метод доступен только платным пользователям.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"payment_required",
"reason":"Метод доступен только платным пользователям."
}
403 Отсутствует разрешение.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"forbidden",
"reason":"Отсутствует разрешение."
}
404 Ресурс не найден
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"not_found",
"reason":"Ресурс не найден"
}
500 Произошла ошибка во время выполнения запроса.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"internal_error",
"reason":"Произошла ошибка во время выполнения запроса."
}
504 Сервер не ответил во время.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"timeout",
"reason":"Сервер не ответил во время."
}

Отклонение заявки на страхование груза

Метод интеграционного API для страхования грузов. Отклоняет заявку со стороны назначенной страховой компании. В теле запроса передаётся причина отклонения для страхователя (поле deflected_notice_comment). Выполнить операцию может только страховая компания, относящаяся к заявке. Отклонение допустимо для заявок в статусах «одобрена», «новая» и «обрабатывается».

Отклоняет заявку на страхование груза назначенной страховой компанией.
post /integration/v1/cargo-insurances/{insuranceId}/deflect
Запрос
Модель
{...}

Запрос на отклонение заявки на страхование.

deflected_notice_comment*: string
От (0 до 255 символов)

Причина отклонения

}
Пример запроса
curl 'https://api.ati.su/integration/v1/cargo-insurances/{insuranceId}/deflect' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"deflected_notice_comment":"Недостаточно документов для оформления"}'
Ответ
200 OK
Модель
{...}

Краткий результат операции над заявкой в интеграционном API (идентификатор, статус и дата смены статуса).

id: uuid

Идентификатор заявки.

status: enum
[Sent, InProgress, Insured, Withdrawn, Request, Deflected, Cancelled, Approved]

Статус заявки в интеграционном API.

  • Sent (Новая)
  • InProgress (Обрабатывается)
  • Insured (Застрахована)
  • Withdrawn (Отозвана)
  • Request (Запрос)
  • Deflected (Отклонена)
  • Cancelled (Аннулирована)
  • Approved (Одобрена)
status_change_date: date-time

Дата и время последнего изменения статуса заявки.

deflected_notice_comment: string (nullable)

Текст причины отклонения для страхователя (если заявка отклонена).

}
Пример
{...}
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status":"Insured",
"status_change_date":"2026-05-28T10:00:00+00:00",
"deflected_notice_comment":"Недостаточно документов"
}
400 Неверные входные данные.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"invalid_input_data",
"reason":"Неверные входные данные."
}
401 Не авторизован
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"un_authorized",
"reason":"Не авторизован"
}
402 Метод доступен только платным пользователям.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"payment_required",
"reason":"Метод доступен только платным пользователям."
}
403 Отсутствует разрешение.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"forbidden",
"reason":"Отсутствует разрешение."
}
404 Ресурс не найден
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"not_found",
"reason":"Ресурс не найден"
}
500 Произошла ошибка во время выполнения запроса.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"internal_error",
"reason":"Произошла ошибка во время выполнения запроса."
}
504 Сервер не ответил во время.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"timeout",
"reason":"Сервер не ответил во время."
}

Подтверждение оплаты клиентом по заявкам на страхование грузов

Метод интеграционного API для страхования грузов. Подтверждает оплату страховки клиентом сразу по нескольким заявкам: в теле запроса передаётся массив идентификаторов заявок. В ответе — результат по каждой заявке отдельно (успех и данные обновлённой заявки или неуспех и текст ошибки). Выполнить операцию может только страховая компания, относящаяся к заявке. Подтверждение допустимо для заявок в статусах «застрахована», «новая», «обрабатывается» и «одобрена». При успешном подтверждении начисляется кешбэк клиенту, статус заявки меняется на «застрахована».

Подтверждает оплату клиентом по списку заявок на страхование грузов от страховой компании для интеграционного АПИ.
post /integration/v1/cargo-insurances/confirm-payments
Запрос
Модель
[uuid]
Пример запроса
curl 'https://api.ati.su/integration/v1/cargo-insurances/confirm-payments' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '["f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7"]'
Ответ
200 OK
Модель
[{...}]

Модель ответа на метод подтверждения оплаты клиентов

id: uuid

Идентификатор заявки.

status: enum
[Sent, InProgress, Insured, Withdrawn, Request, Deflected, Cancelled, Approved]

Статус заявки в интеграционном API.

  • Sent (Новая)
  • InProgress (Обрабатывается)
  • Insured (Застрахована)
  • Withdrawn (Отозвана)
  • Request (Запрос)
  • Deflected (Отклонена)
  • Cancelled (Аннулирована)
  • Approved (Одобрена)
status_change_date: date-time

Дата и время последнего изменения статуса заявки.

success: boolean

Успешно ли подтверждена оплата по заявке.

error_message: string (nullable)

Сообщение об ошибке, если подтверждение неуспешно

client_payment_date: date-time (nullable)

Дата оплаты страхового взноса клиентом

cash_back_sum: double (nullable)

Сумма кэшбека в атисах

cash_back_percent: double (nullable)

Процент кэшбека

}]
Пример
[...]
{...}
"id":"f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7",
"status":"Insured",
"status_change_date":"2026-05-28T10:00:00+00:00",
"success":true,
"error_message":"Заявка не найдена",
"client_payment_date":"2026-05-29T14:30:00+00:00",
"cash_back_sum":150,
"cash_back_percent":5
}
]
400 Неверные входные данные.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"invalid_input_data",
"reason":"Неверные входные данные."
}
401 Не авторизован
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"un_authorized",
"reason":"Не авторизован"
}
402 Метод доступен только платным пользователям.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"payment_required",
"reason":"Метод доступен только платным пользователям."
}
403 Отсутствует разрешение.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"forbidden",
"reason":"Отсутствует разрешение."
}
404 Ресурс не найден
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"not_found",
"reason":"Ресурс не найден"
}
500 Произошла ошибка во время выполнения запроса.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"internal_error",
"reason":"Произошла ошибка во время выполнения запроса."
}
504 Сервер не ответил во время.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"timeout",
"reason":"Сервер не ответил во время."
}

Получение файлов заявки на страхование груза

Метод интеграционного API для страхования грузов. Возвращает список файлов, прикреплённых к заявке на страхование груза (ссылки для скачивания). Операция доступна только страховой компании, которой принадлежит заявка: фирма из токена должна совпадать со страховщиком по заявке.

Возвращает список файлов заявки на страхование груза для интеграционного API.
get /integration/v1/insurance-cargo/{insuranceId}/files
Запрос
Пример запроса
curl 'https://api.ati.su/integration/v1/insurance-cargo/{insuranceId}/files' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 OK
Модель
[{...}]

Ссылка на файл.

name: string (nullable)

Наименование файла.

url: string (nullable)

URL файла.

}]
Пример
[...]
{...}
"name":"policy.pdf",
"url":"https://example.com/policy.pdf"
}
]
400 Неверные входные данные.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"invalid_input_data",
"reason":"Неверные входные данные."
}
401 Не авторизован
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"un_authorized",
"reason":"Не авторизован"
}
402 Метод доступен только платным пользователям.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"payment_required",
"reason":"Метод доступен только платным пользователям."
}
403 Отсутствует разрешение.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"forbidden",
"reason":"Отсутствует разрешение."
}
404 Ресурс не найден
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"not_found",
"reason":"Ресурс не найден"
}
500 Произошла ошибка во время выполнения запроса.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"internal_error",
"reason":"Произошла ошибка во время выполнения запроса."
}
504 Сервер не ответил во время.
Модель
{...}

Модель ошибки ответа API.

error: string (nullable)

Код или тип ошибки.

reason: string (nullable)

Подробное описание причины ошибки.

}
Пример
{...}
"error":"timeout",
"reason":"Сервер не ответил во время."
}