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

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

Максимальный разрешенный размер - 10 Мб Поддерживаемые форматы: .bmp, .doc, .docx, .gif, .jpeg, .jpg, .odt, .pdf, .png, .pps, .ppsx, .ppt, .pptx, .rar, .rtf, .tif, .tiff, .txt, .xls, .xlsx, .xml, .cer, .crt, .pem, .wmv, .mdi

Возможности сервиса

• Работа с логотипами и аватарками
• Работа с файлами

Методы для работы с аватарками/логотипам

Загрузка логотипа фирмы или аватарки контакта

Загружает логотип фирмы или аватарку контакта

Загружает логотип фирмы или аватарку контакта

post /avatars/

Модель и примеры

Запрос

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

CURL

curl 'https://api.ati.su/avatars/' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'

1C

Процедура Выполнить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", "/avatars/");

Ответ

200 Информация о загруженной аватарке/логотипе

Модель

{...}

ok: boolean

Идентификатор успешности запроса

url: string

Ссылка на сохраненный аватар

name: string

Имя сохраненной аватарки

}

Пример

{...}

"ok":false,

"url":"string",

"name":"string"

}

401 Ошибка авторизации

Модель

null

Пример

null

Консоль

Отправить

Параметры

account string

img

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

Удаляет логотип фирмы или аватарку контакт

Удаляет логотип фирмы или аватарку контакта

delete /avatars/

Модель и примеры

Запрос

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

CURL

curl 'https://api.ati.su/avatars/' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура Выполнить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", "/avatars/");

Ответ

200 Логотип/аватарка удалена

Модель

null

Пример

null

401 Ошибка авторизации

Модель

null

Пример

null

Консоль

Отправить

Параметры

account string

Загрузка логотипа фирмы

Загружает логотип фирмы

Загружает логотип фирмы

post /avatars/logo

Модель и примеры

Запрос

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

CURL

curl 'https://api.ati.su/avatars/logo' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'

1C

Процедура Выполнить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", "/avatars/logo");

Ответ

200 Информация о загруженной аватарке/логотипе

Модель

{...}

ok: boolean

Идентификатор успешности запроса

url: string

Ссылка на сохраненный аватар

name: string

Имя сохраненной аватарки

}

Пример

{...}

"ok":false,

"url":"string",

"name":"string"

}

401 Ошибка авторизации

Модель

null

Пример

null

Консоль

Отправить

Параметры

img

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

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

Удаляет логотип фирмы или аватарку контакта

delete /avatars/

Модель и примеры

Запрос

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

CURL

curl 'https://api.ati.su/avatars/' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура Выполнить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", "/avatars/");

Ответ

200 Логотип/аватарка удалена

Модель

null

Пример

null

401 Ошибка авторизации

Модель

null

Пример

null

Консоль

Отправить

Параметры

account string

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

Загрузка файла

Сохраняет файл на файловую систему

Описание тела запроса

{
  "firms": {
    "type": "string",
    "description": "Список фирм, имеющих доступ к этому документу"
  },
  "rawBody": {
    "type": "string",
    "format": "binary",
    "description": "Тело файла"
  }
}

Загрузить файл в хранилище

post /v1.0/filestorage/files/

Модель и примеры

Запрос

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

CURL

curl 'https://api.ati.su/v1.0/filestorage/files/' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'

1C

Процедура Выполнить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.0/filestorage/files/");

Ответ

200 Информация о файле - id

Модель

{...}

ok: boolean

Идентификатор успешности запроса

result:{...}

id: string

Идентификатор файла

fileName: string

Имя файла

size: integer

Размер файла в байтах

mimetype: string

Тип файла

link: string

Ссылка на файл для скачивания

}

}

Пример

{...}

"ok":false,

"result":{...}

"id":"string",

"fileName":"string",

"size":0,

"mimetype":"string",

"link":"string"

}

}

400 Отсутствует файл в поле rawBody, или Отправлен пустой файл

Модель

null

Пример

null

401 Ошибка авторизации

Модель

null

Пример

null

Консоль

Отправить

Параметры

firms

rawBody

Загрузка нескольких файлов

Метод позволяет загрузить сразу несколько файлов на файловую систему.

Описание тела запроса

{
  "firms": {
    "type": "string",
    "description": "Список фирм, имеющих доступ к этому документу"
  },
  "rawBody": {
    "type": "array",
    "items": {
      "type": "string",
      "format": "binary",
      "description": "Список из тел файла"
    }
  }
}

Если файл загрузить не удалось, то для него возвращается схема

{
  "error": {
    "type": "string",
    "title": "Идентификатор ошибки"
  },
  "reason": {
    "type": "string",
    "title": "Текст ошибки"
  },
  "id": {
    "type": "string",
    "title": "Идентификатор файла"
  }
}

Загрузить несколько файлов в хранилище

post /v1.0/filestorage/files/multiple

Модель и примеры

Запрос

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

CURL

curl 'https://api.ati.su/v1.0/filestorage/files/multiple' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: multipart/form-data; boundary=boundary'

1C

Процедура Выполнить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.0/filestorage/files/multiple");

Ответ

200 Список с информацией о созданных файлах и ошибках

Модель

[{...}]

ok: boolean

result:{...}

id: string

fileName: string

size: integer

mimetype: string

link: string

}

}]

Пример

[...]

{...}

"ok":false,

"result":{...}

"id":"string",

"fileName":"string",

"size":0,

"mimetype":"string",

"link":"string"

}

}

]

400 Отсутствует или пустое поле rawBody

Модель

null

Пример

null

401 Ошибка авторизации

Модель

null

Пример

null

Консоль

Отправить

Параметры

firms

rawBody

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

Метод удаляет загруженный файл

Удалить файл

delete /v1.0/filestorage/files/{file_id}/

Модель и примеры

Запрос

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

CURL

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

1C

Процедура Выполнить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.0/filestorage/files/{file_id}/");

Ответ

200 Подверждение об удалении файла

Модель

null

Пример

null

400 Файл не найден

Модель

null

Пример

null

Консоль

Отправить

Параметры

file_id string

Удаление нескольких файлов

Метод позволяет удалить сразу несколько загруженных файлов.

Если файл удалить не удалось, то для него возвращается схема

{
  "error": {
    "type": "string",
    "title": "Идентификатор ошибки"
  },
  "reason": {
    "type": "string",
    "title": "Текст ошибки"
  },
  "id": {
    "type": "string",
    "title": "Идентификатор файла"
  }
}

Удалить несколько файлов из хранилища

delete /v1.0/filestorage/files/multiple

Модель и примеры

Запрос

Модель

[string]

Идентификатор файла

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

CURL

curl 'https://api.ati.su/v1.0/filestorage/files/multiple' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '["string"]'

1C

Процедура Выполнить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.0/filestorage/files/multiple", "[""string""]");

Ответ

200 Список с информацией о созданных файлах и ошибках

Модель

[{...}]

ok: boolean

id: string

}]

Пример

[...]

{...}

"ok":false,

"id":"string"

}

]

400 Отсутствует или пустое поле rawBody

Модель

null

Пример

null

401 Ошибка авторизации

Модель

null

Пример

null

Консоль

Отправить

Параметры

Нет параметров

[ "string" ]

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

Возвращает файл по его file_id

Получить файл по его ID

get /v1.0/filestorage/files/{file_id}/

Модель и примеры

Запрос

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

CURL

curl 'https://api.ati.su/v1.0/filestorage/files/{file_id}/' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура Выполнить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Запрос("GET", "https://api.ati.su", "/v1.0/filestorage/files/{file_id}/");

Ответ

200 Содержимое файла

Модель

null

Пример

null

400 Файл не найден

Модель

null

Пример

null

Консоль

Отправить

Параметры

file_id string