Box
Управление файлами, папками и электронными подписями с помощью Box
Box — это ведущая платформа управления облачным контентом и обмена файлами, которой доверяют предприятия по всему миру для безопасного хранения, управления и совместной работы над файлами. Box предоставляет надежные API для автоматизации файловых операций и интеграции с бизнес-процессами, включая Box Sign для нативных электронных подписей.
С интеграцией Box в AACFlow вы можете:
- Загружать файлы: Загружать документы, изображения и другие файлы в любую папку Box
- Скачивать файлы: Получать содержимое файлов из Box для обработки в ваших рабочих процессах
- Получать информацию о файлах: Получать доступ к подробным метаданным, включая размер, владельца, временные метки, теги и общие ссылки
- Просматривать содержимое папок: Просматривать файлы и папки с поддержкой сортировки и пагинации
- Создавать папки: Организовывать хранилище Box, создавая новые папки программно
- Удалять файлы и папки: Удалять контент с опциональным рекурсивным удалением для папок
- Копировать файлы: Дублировать файлы между папками с опциональным переименованием
- Искать: Находить файлы и папки по имени, содержимому, расширению или местоположению
- Обновлять метаданные файлов: Переименовывать, перемещать, добавлять описания или тегировать файлы
- Создавать запросы на подпись: Отправлять документы для электронной подписи с одним или несколькими подписывающими
- Отслеживать статус подписания: Мониторить прогресс запросов на подпись
- Просматривать запросы на подпись: Просматривать все запросы на подпись с пагинацией на основе маркеров
- Отменять запросы на подпись: Отменять ожидающие запросы на подпись, которые больше не нужны
- Повторно отправлять напоминания о подписи: Отправлять уведомления-напоминания подписывающим, которые не завершили подписание
Эти возможности позволяют вашим агентам AACFlow автоматизировать операции Box непосредственно в ваших рабочих процессах — от организации документов и распространения контента до обработки загруженных файлов, управления рабочими процессами электронной подписи для предложений о работе и контрактов, а также поддержания структурированного облачного хранилища в рамках ваших бизнес-процессов.
Интегрируйте Box в ваш рабочий процесс для управления файлами, папками и электронными подписями. Загружайте и скачивайте файлы, ищите контент, создавайте папки, отправляйте документы для электронной подписи, отслеживайте статус подписания и многое другое.
Загрузить файл в папку Box
| Параметр | Тип | Обязательный | Описание |
|---|
parentFolderId | string | Да | ID папки для загрузки файла (используйте "0" для корневой папки) |
file | file | Нет | Файл для загрузки (объект UserFile) |
fileContent | string | Нет | Устаревший: содержимое файла в кодировке base64 |
fileName | string | Нет | Опциональное переопределение имени файла |
| Параметр | Тип | Описание |
|---|
id | string | ID файла |
name | string | Имя файла |
size | number | Размер файла в байтах |
sha1 | string | SHA1-хэш содержимого файла |
createdAt | string | Временная метка создания |
modifiedAt | string | Временная метка последнего изменения |
parentId | string | ID родительской папки |
parentName | string | Имя родительской папки |
Скачать файл из Box
| Параметр | Тип | Обязательный | Описание |
|---|
fileId | string | Да | ID файла для скачивания |
| Параметр | Тип | Описание |
|---|
file | file | Скачанный файл, сохраненный в файлах выполнения |
content | string | Содержимое файла в кодировке base64 |
Получить подробную информацию о файле в Box
| Параметр | Тип | Обязательный | Описание |
|---|
fileId | string | Да | ID файла для получения информации |
| Параметр | Тип | Описание |
|---|
id | string | ID файла |
name | string | Имя файла |
size | number | Размер файла в байтах |
sha1 | string | SHA1-хэш содержимого файла |
createdAt | string | Временная метка создания |
modifiedAt | string | Временная метка последнего изменения |
parentId | string | ID родительской папки |
parentName | string | Имя родительской папки |
ownerId | string | ID владельца файла |
ownerName | string | Имя владельца файла |
description | string | Описание файла |
tags | array | Теги файла |
sharedLink | string | Общая ссылка на файл (если доступна) |
path | array | Путь к файлу в виде массива объектов папок |
↳ id | string | ID папки в пути |
↳ name | string | Имя папки в пути |
Просмотреть содержимое папки Box
| Параметр | Тип | Обязательный | Описание |
|---|
folderId | string | Да | ID папки для просмотра (используйте "0" для корневой папки) |
limit | number | Нет | Максимальное количество элементов для возврата (по умолчанию 100, максимум 1000) |
offset | number | Нет | Смещение для пагинации (по умолчанию 0) |
sort | string | Нет | Поле для сортировки: name, date, size (по умолчанию name) |
direction | string | Нет | Направление сортировки: ASC или DESC (по умолчанию ASC) |
| Параметр | Тип | Описание |
|---|
items | array | Массив элементов (файлов и папок) |
↳ type | string | Тип элемента: file или folder |
↳ id | string | ID элемента |
↳ name | string | Имя элемента |
↳ size | number | Размер (только для файлов) |
↳ createdAt | string | Временная метка создания |
↳ modifiedAt | string | Временная метка последнего изменения |
totalCount | number | Общее количество элементов в папке |
offset | number | Текущее смещение |
limit | number | Текущий лимит |
Создать новую папку в Box
| Параметр | Тип | Обязательный | Описание |
|---|
parentFolderId | string | Да | ID родительской папки (используйте "0" для корневой папки) |
name | string | Да | Имя новой папки |
| Параметр | Тип | Описание |
|---|
id | string | ID созданной папки |
name | string | Имя папки |
createdAt | string | Временная метка создания |
modifiedAt | string | Временная метка последнего изменения |
parentId | string | ID родительской папки |
parentName | string | Имя родительской папки |
Удалить файл из Box
| Параметр | Тип | Обязательный | Описание |
|---|
fileId | string | Да | ID файла для удаления |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Был ли файл удален |
Удалить папку из Box
| Параметр | Тип | Обязательный | Описание |
|---|
folderId | string | Да | ID папки для удаления |
recursive | boolean | Нет | Рекурсивно удалить все содержимое папки (по умолчанию false) |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Была ли папка удалена |
Копировать файл в другую папку Box
| Параметр | Тип | Обязательный | Описание |
|---|
fileId | string | Да | ID файла для копирования |
destinationFolderId | string | Да | ID папки назначения |
newName | string | Нет | Новое имя для копии файла |
| Параметр | Тип | Описание |
|---|
id | string | ID скопированного файла |
name | string | Имя скопированного файла |
size | number | Размер файла в байтах |
sha1 | string | SHA1-хэш содержимого файла |
createdAt | string | Временная метка создания |
modifiedAt | string | Временная метка последнего изменения |
parentId | string | ID родительской папки |
parentName | string | Имя родительской папки |
Поиск файлов и папок в Box
| Параметр | Тип | Обязательный | Описание |
|---|
query | string | Да | Поисковый запрос |
scope | string | Нет | Область поиска: user_content, enterprise_content (по умолчанию user_content) |
fileExtensions | string | Нет | Расширения файлов для фильтрации через запятую (например, pdf,docx) |
limit | number | Нет | Максимальное количество результатов (по умолчанию 30, максимум 200) |
offset | number | Нет | Смещение для пагинации (по умолчанию 0) |
| Параметр | Тип | Описание |
|---|
results | array | Массив результатов поиска |
↳ type | string | Тип элемента: file или folder |
↳ id | string | ID элемента |
↳ name | string | Имя элемента |
↳ size | number | Размер (только для файлов) |
↳ createdAt | string | Временная метка создания |
↳ modifiedAt | string | Временная метка последнего изменения |
↳ path | array | Путь к элементу |
totalCount | number | Общее количество результатов |
offset | number | Текущее смещение |
limit | number | Текущий лимит |
Обновить метаданные файла в Box
| Параметр | Тип | Обязательный | Описание |
|---|
fileId | string | Да | ID файла для обновления |
name | string | Нет | Новое имя файла |
description | string | Нет | Новое описание файла |
parentFolderId | string | Нет | Новая родительская папка (для перемещения файла) |
tags | string | Нет | JSON-массив тегов для добавления к файлу |
| Параметр | Тип | Описание |
|---|
id | string | ID файла |
name | string | Имя файла |
description | string | Описание файла |
tags | array | Теги файла |
parentId | string | ID родительской папки |
parentName | string | Имя родительской папки |
Создать запрос на электронную подпись с помощью Box Sign
| Параметр | Тип | Обязательный | Описание |
|---|
fileId | string | Да | ID файла для подписания |
signers | string | Да | JSON-массив подписывающих (например, [\{"email":"signer@example.com","role":"signer"\}]) |
subject | string | Нет | Тема письма с запросом на подпись |
message | string | Нет | Сообщение для подписывающих |
redirectUrl | string | Нет | URL для перенаправления после подписания |
expiresInDays | number | Нет | Количество дней до истечения срока запроса (по умолчанию 30) |
| Параметр | Тип | Описание |
|---|
signRequestId | string | ID запроса на подпись |
status | string | Статус запроса: converting, created, sent, viewed, signed, cancelled, declined, error |
signers | array | Информация о подписывающих |
↳ email | string | Email подписывающего |
↳ role | string | Роль подписывающего: signer, approver, etc. |
↳ status | string | Статус подписывающего |
createdAt | string | Временная метка создания |
expiresAt | string | Временная метка истечения срока |
Получить информацию о запросе на электронную подпись
| Параметр | Тип | Обязательный | Описание |
|---|
signRequestId | string | Да | ID запроса на подпись |
| Параметр | Тип | Описание |
|---|
signRequestId | string | ID запроса на подпись |
status | string | Статус запроса: converting, created, sent, viewed, signed, cancelled, declined, error |
signers | array | Информация о подписывающих |
↳ email | string | Email подписывающего |
↳ role | string | Роль подписывающего: signer, approver, etc. |
↳ status | string | Статус подписывающего |
createdAt | string | Временная метка создания |
expiresAt | string | Временная метка истечения срока |
completedAt | string | Временная метка завершения (если применимо) |
declinedReason | string | Причина отказа (если применимо) |
Просмотреть все запросы на электронную подпись
| Параметр | Тип | Обязательный | Описание |
|---|
limit | number | Нет | Максимальное количество запросов для возврата (по умолчанию 100, максимум 500) |
marker | string | Нет | Маркер для пагинации (из предыдущего ответа) |
| Параметр | Тип | Описание |
|---|
signRequests | array | Массив запросов на подпись |
↳ signRequestId | string | ID запроса на подпись |
↳ status | string | Статус запроса |
↳ createdAt | string | Временная метка создания |
↳ expiresAt | string | Временная метка истечения срока |
nextMarker | string | Маркер для следующей страницы (если есть) |
Отменить запрос на электронную подпись
| Параметр | Тип | Обязательный | Описание |
|---|
signRequestId | string | Да | ID запроса на подпись для отмены |
| Параметр | Тип | Описание |
|---|
cancelled | boolean | Был ли запрос отменен |
Повторно отправить напоминание о подписи
| Параметр | Тип | Обязательный | Описание |
|---|
signRequestId | string | Да | ID запроса на подпись |
signerEmail | string | Да | Email подписывающего для отправки напоминания |
| Параметр | Тип | Описание |
|---|
resent | boolean | Было ли напоминание отправлено повторно |