API для работы с файлами, логотипами и аватарками

В данном разделе вы можете найти методы для работы с файлами, логотипами и аватарками фирм и контактов

Максимальный разрешенный размер - 20 Мб

Поддерживаемые форматы: .png, .jpeg, .jpg, .jpe, .jif, .jfif, .rtf, .tif, .tiff, .bmp, .doc, .docx, .gif, .odt, .pdf, .xls, .xlsx, .csv, .heic, .txt

Для загрузки логотипов фирм и аватарок контактов: .png, .jpeg, .jpg, .jpe, .jif, .jfif.

Методы для работы с файлами

Добавление файлов

Метод загрузки файлов

post

/v1/filer/

business_type

string

with_watermark

boolean

access_type

string

file_key_2

string

file

binary

contact_id

int32

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"file_key":"string",

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

"file_key2":"string",

"file_name":"string",

"content_type":"string",

"access_type":"Public",

"file_business_type":"FirmDocument",

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

"firm_id":0,

"contact_id":0,

"with_watermark":false

}

{...}

file_key: string (nullable)

deleted_date: date-time (nullable)

file_key2: string (nullable)

file_name: string (nullable)

content_type: string (nullable)

access_type: enum

[Public, Firm, Contact, Authorized]

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

file_business_type: enum

[FirmDocument, Avatar, Logo, Load, Orders, CatalogsTrucks, CatalogsDrivers]

Тип файла

add_date: date-time

firm_id: int32 (nullable)

contact_id: int32 (nullable)

with_watermark: boolean (nullable)

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

business_type - тип файла

Доступны следующие варианты: FirmDocument, Avatar, Logo, Load, Orders, CatalogsTrucks, CatalogsDrivers.

access_type - доступ к файлу

Public - файл доступен всем;
Firm - файл доступен всей фирме контакта, который сохранил файл;
Contact - файл доступен только тому контакту, который сохранил файл;
Authorized - получать файлы могут любые, но только авторизованные пользователи.

Для некоторых business_type файлов можно указать только определенные access_type:

для Avatar/Logo можно указать только access_type = Public;
для FirmDocument, CatalogsTrucks/CatalogsDrivers, Orders и Load можно указать только access_type = Authorized.

Получение файлов

Получение файла по fileKey

get

/v1/filer/{fileKey}

fileKey

string

Можно запрашивать по fileKey или fileKey2

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

"c3RyaW5n"

byte

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение информации о файлах

post

/v1/filer/info

Развернуть все Свернуть все

body

object

{...}

ati_id: string (nullable)

Код участника в ATI.SU

contact_id: int32 (nullable)

Id контакта

business_type: enum

[FirmDocument, Avatar, Logo, Load, Orders, CatalogsTrucks, CatalogsDrivers]

Тип файла

keys: [string]

Id файла

keys2: [string]

Id файла в формате GUID

}

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"file_key":"string",

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

"file_key2":"string",

"file_name":"string",

"content_type":"string",

"access_type":"Public",

"file_business_type":"FirmDocument",

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

"firm_id":0,

"contact_id":0,

"with_watermark":false

}

]

[{...}]

file_key: string (nullable)

deleted_date: date-time (nullable)

file_key2: string (nullable)

file_name: string (nullable)

content_type: string (nullable)

access_type: enum

[Public, Firm, Contact, Authorized]

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

file_business_type: enum

[FirmDocument, Avatar, Logo, Load, Orders, CatalogsTrucks, CatalogsDrivers]

Тип файла

add_date: date-time

firm_id: int32 (nullable)

contact_id: int32 (nullable)

with_watermark: boolean (nullable)

}]

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

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

Для получения информации о файлах нужно передавать в теле параметры (или):

“ati_id” и “business_type”;
“keys”/“keys2”.

Проверка прав на просмотр файла осуществляется через авторизационный хэдер. Чтобы получить информацию о том, кто создал файл, нужно передать в тело запроса параметр “ati_id"или “ati_id” и “contact_id”.

Получение лого фирмы

get

/v1/filer/logo/{atiId}

atiId

string

Код участника в ATI.SU

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

"c3RyaW5n"

byte

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение аватара контакта

get

/v1/filer/avatar/{atiId}/{contactId}

atiId

string

Код участника в ATI.SU

contactId

int32

Id контакта

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

"c3RyaW5n"

byte

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение дефолтной аватарки

get

/v1/filer/avatar/default

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

"c3RyaW5n"

byte

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение дефолтного лого

get

/v1/filer/logo/default

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

"c3RyaW5n"

byte

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление файлов

Удаление файла по fileKey

delete

/v1/filer/{fileKey}

fileKey

string

Можно запрашивать по fileKey или fileKey2

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Файлы FirmDocument, CatalogsTrucks/CatalogsDrivers, Orders и Load можно удалять независимо от прав и расположения в подразделениях.

Удаление логотипа фирмы

delete

/v1/filer/type/logo

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Для удаления логотипа фирмы, надо быть в Головном подразделении и иметь право “Администрировать контакты и подразделения”

Удаление аватара контакта

delete

/v1/filer/type/avatar

contact-id

int32

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

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string (nullable)

reason: string (nullable)

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Для удаления своего аватара нужно иметь право “Редактировать и удалять свою контактную информацию” и иметь право “Администрировать контакты и подразделения”.

Для удаления чужого аватара нужно быть в одном подразделении с контактом и иметь право “Администрировать контакты и подразделения”.