Получение списка файлов, хранящихся в amoCRM через API, является важной функцией для организации и управления документами. Этот процесс позволяет вам программно получать информацию о всех загруженных файлах, что необходимо для создания отчетов, автоматизации задач и интеграции с другими системами. Рассмотрим детально, как получить список файлов, какие параметры доступны и как обрабатывать полученные данные.
Подготовка к запросу:
- Авторизация: Как и при загрузке файлов, для получения списка файлов необходимо авторизоваться в API amoCRM, используя заголовок Authorization: Bearer access токен.
- Конечная точка API: Для получения списка файлов необходимо выполнить GET-запрос к конечной точке
/api/v4/files.
- Параметры запроса: API предоставляет несколько параметров, которые позволяют фильтровать и сортировать список файлов:
- limit: Максимальное количество файлов, возвращаемых в одном запросе (по умолчанию 100, максимум 500).
- offset: Смещение от начала списка (используется для пагинации).
- query: Поисковый запрос по имени файла.
Пример запроса:
GET /api/v4/files?limit=50&offset=0&query=Договор
Authorization: Bearer YOUR_ACCESS_TOKEN
Обработка ответа:
В случае успешного запроса API вернет ответ в формате JSON, содержащий массив объектов, каждый из которых представляет собой информацию о файле. Каждый объект файла содержит следующие поля:
- id: Уникальный идентификатор файла.
- name: Имя файла.
- type: Тип файла (MIME-тип).
- size: Размер файла в байтах.
- url: Ссылка на скачивание файла.
- created_at: Дата и время создания файла.
- updated_at: Дата и время последнего обновления файла.
Пример ответа (упрощенный):
{
"total": 12,
"results": [
{
"id": 123,
"name": "Договор_с_ООО_Ромашка.pdf",
"type": "application/pdf",
"size": 123456,
"url": "https://example.com/files/123.pdf",
"created_at": "2024-09-24T10:00:00Z",
"updated_at": "2024-09-24T10:00:00Z"
},
{
"id": 456,
"name": "Презентация_продукта.pptx",
"type": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
"size": 654321,
"url": "https://example.com/files/456.pptx",
"created_at": "2024-09-23T15:30:00Z",
"updated_at": "2024-09-23T15:30:00Z"
} ]
}
Важные рекомендации:
- Пагинация: Если общее количество файлов превышает значение параметра
limit, необходимо использовать пагинацию, чтобы получить все файлы. Для этого нужно последовательно отправлять запросы с разными значениями параметра offset.
- Обработка ошибок: Всегда обрабатывайте возможные ошибки при запросе списка файлов.
- Кэширование: Для повышения производительности можно кэшировать список файлов на стороне клиента.
Получение списка файлов через API amoCRM предоставляет гибкий и эффективный способ управления документами, позволяя автоматизировать процессы и интегрировать amoCRM с другими системами.
