Файлы в заказах

Как работать с файлами ATI.SU

Методы для работы с файлами в Заказах

Прикрепление данных файла к Заказу

Добавление данных файла к заказу

post /v1.2/orders/files/info

Модель и примеры
Консоль

Запрос

Модель

ONE-OF

(nullable)

1:{...}

deal_id: guid

ID заказа

file_info:

Данные о загруженном файле

ONE-OF

1:{...}

file_id: string

Id файла

file_name: string

Название файла

}

file_type:

Тип файла

ONE-OF

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17]

Тип файла

0 — Другой документ
1 — Товарно-транспортная накладная
2 — Товарная накладная
3 — Транспортная накладная
4 — Накладная
5 — Счет-фактура
6 — Счет на оплату
7 — Платежное поручение
8 — Акт выполненных работ
9 — Заявка
10 — Заявка к договору
11 — Заказ
12 — Договор
13 — Доп. соглашение к договору
14 — Доверенность
15 — Поручение экспедитору
16 — Информационное письмо
17 — Документ о происшествии с грузом/ТС

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/orders/files/info' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"deal_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","file_info":{"file_id":"string","file_name":"string"},"file_type":{}}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v1.2/orders/files/info", "{""deal_id"":""3fa85f64-5717-4562-b3fc-2c963f66afa6"",""file_info"":{""file_id"":""string"",""file_name"":""string""},""file_type"":{}}");

Ответ

200 Успешное добавление

Модель

{...}

Файлы заказа

id: guid (nullable)

Id файла

storage_file_id: string (nullable)

Id файла в хранилище

access:

Доступ к файлу

* 0 — только загрузивший файл
* 1 — обе стороны
* 2 — загрузивший файл и водитель
* 3 — доступен обеим сторонам и водителю

ONE-OF

(nullable)

enum

[0, 1, 2, 3]

Доступ к файлу

0 — только загрузивший файл
1 — обе стороны
2 — загрузивший файл и водитель
3 — доступен обеим сторонам и водителю

add_date: date-time (nullable)

Время загрузки файла

deal_id: guid

Id связанного Заказа

is_counterparty_file: boolean (nullable)

Файл контрагента

file_name: string (nullable)

Имя файла

size: int32 (nullable)

Размер файла

link: string (nullable)

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

file_id: string (nullable)

ID файла

source_type:

Источник файла

* 0 — Загружен в заказ
* 1 — Скопирован из груза
* 2 — Скопирован из данных о водителе
* 3 — Скопироване из данных о грузовике
* 4 — Скопирован из данных о прицепе
* 5 — Скопирован из данных о полуприцепе
* 6 — Скопирован из данных о тягаче
* 7 — Загружен для Ати-водителя

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

Источник файла

0 — Загружен в заказ
1 — Скопирован из груза
2 — Скопирован из данных о водителе
3 — Скопироване из данных о грузовике
4 — Скопирован из данных о прицепе
5 — Скопирован из данных о полуприцепе
6 — Скопирован из данных о тягаче
7 — Загружен для Ати-водителя
8 — Загружен из приложения АТИ-водитель
9 — Загружен из Gallifrey (Временные окна)

source_file_type:

Тип загруженного файла

* 0 — Обычный файл
* 1 — Водительское удостоверение
* 2 — Паспорт водителя
* 3 — Техпаспорт ТС
* 4 — Пластик
* 5 — Фото ТС

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4, 5, 8]

Тип загруженного файла

0 — Обычный файл
1 — Скан водительского удостоверения
2 — Скан гражданского паспорта водителя
3 — Скан ПТС
4 — Скан пластикового ПТС
5 — Фото ТС
8 - Скан договора о безвоздмездном пользовании

file_type:

Тип файла

* 0 — Другой документ
* 1 — Товарно-транспортная накладная
* 2 — Товарная накладная
* 3 — Транспортная накладная
* 4 — Накладная
* 5 — Счет-фактура
* 6 — Счет на оплату
* 7 — Платежное поручение
* 8 — Акт выполненных работ
* 9 — Заявка
* 10 — Заявка (к договору)
* 11 — Заказ
* 12 — Договор
* 13 — Доп. соглашение (к договору)
* 14 — Доверенность
* 15 — Поручение экспедитору
* 16 — Информационное письмо
* 17 — Документ о происшествии с грузом/ТС

ONE-OF

(nullable)

enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17]

Тип файла

0 — Другой документ
1 — Товарно-транспортная накладная
2 — Товарная накладная
3 — Транспортная накладная
4 — Накладная
5 — Счет-фактура
6 — Счет на оплату
7 — Платежное поручение
8 — Акт выполненных работ
9 — Заявка
10 — Заявка к договору
11 — Заказ
12 — Договор
13 — Доп. соглашение к договору
14 — Доверенность
15 — Поручение экспедитору
16 — Информационное письмо
17 — Документ о происшествии с грузом/ТС

timeslots_warehouse_ids: [int32]

Список складов с Временными окнами с доступом к файлу

}

Пример

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"storage_file_id":"string",

"access":{},

"add_date":"1970-01-01T00:00:00.000Z",

"deal_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"is_counterparty_file":false,

"file_name":"string",

"size":0,

"link":"string",

"file_id":"string",

"source_type":{},

"source_file_type":{},

"file_type":{},

"timeslots_warehouse_ids":[...]

]

}

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

ONE-OF

(nullable)

1:{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Удаление приложенного файла Заказа

Удаление приложенного файла заказа

delete /v1.2/orders/files/{fileId}

Модель и примеры
Консоль

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/orders/files/{fileId}' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/v1.2/orders/files/{fileId}");

Ответ

200 Успешное удаление

Успешный ответ

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

ONE-OF

(nullable)

1:{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}

Настройка доступа к файлу Заказа

Настройка доступа к файлу заказа

put /v1.2/orders/files/{fileId}/access

Модель и примеры
Консоль

Запрос

Модель

ONE-OF

(nullable)

1:{...}

access:

Доступ к файлу

ONE-OF

enum

[0, 1, 2, 3]

Доступ к файлу

0 — только загрузивший файл
1 — обе стороны
2 — загрузивший файл и водитель
3 — доступен обеим сторонам и водителю

timeslots_warehouse_ids: [int32]

Список складов с Временными окнами с доступом к файлу

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.2/orders/files/{fileId}/access' \
  -X 'PUT' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"access":{},"timeslots_warehouse_ids":[0]}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/v1.2/orders/files/{fileId}/access", "{""access"":{},""timeslots_warehouse_ids"":[0]}");

Ответ

200 Успешное изменение доступа

Модель

binary

Пример

"binary"

4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)

Модель

ONE-OF

(nullable)

1:{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Пример

{...}

"reason":"string",

"error":"string"

}