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

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/
Запрос
Пример запроса 
curl 'https://api.ati.su/v1/filer/' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'
Ответ
200 Success
Модель
{...}
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)
}
Пример
{...}
"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
}
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}

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}
Запрос
Пример запроса 
curl 'https://api.ati.su/v1/filer/{fileKey}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
byte
Пример
"c3RyaW5n"
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
Получение информации о файлах
post /v1/filer/info
Запрос
Модель
{...}
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 'https://api.ati.su/v1/filer/info' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ati_id":"string","contact_id":0,"business_type":"FirmDocument","keys":["string"],"keys2":["string"]}'
Ответ
200 Success
Модель
[{...}]
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)
}]
Пример
[...]
{...}
"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
}
]
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}

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

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

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

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

Получение лого фирмы
get /v1/filer/logo/{atiId}
Запрос
Пример запроса 
curl 'https://api.ati.su/v1/filer/logo/{atiId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
byte
Пример
"c3RyaW5n"
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
Получение аватара контакта
get /v1/filer/avatar/{atiId}/{contactId}
Запрос
Пример запроса 
curl 'https://api.ati.su/v1/filer/avatar/{atiId}/{contactId}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
byte
Пример
"c3RyaW5n"
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
Получение дефолтной аватарки
get /v1/filer/avatar/default
Запрос
Пример запроса 
curl 'https://api.ati.su/v1/filer/avatar/default' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
byte
Пример
"c3RyaW5n"
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
Получение дефолтного лого
get /v1/filer/logo/default
Запрос
Пример запроса 
curl 'https://api.ati.su/v1/filer/logo/default' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
byte
Пример
"c3RyaW5n"
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}

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

Удаление файла по fileKey
delete /v1/filer/{fileKey}
Запрос
Пример запроса 
curl 'https://api.ati.su/v1/filer/{fileKey}' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
null
Пример
null
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}

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

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

Удаление аватара контакта
delete /v1/filer/type/avatar
Запрос
Пример запроса 
curl 'https://api.ati.su/v1/filer/type/avatar' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Success
Модель
null
Пример
null
400 Bad Request
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string (nullable)
reason: string (nullable)
}
Пример
{...}
"error":"string",
"reason":"string"
}

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

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