Бипуим: Документация
8-800-505-24-05Сайт Бипиум
  • 😎Отвечаем на ваши вопросы
  • 🎂Версии и обновления
  • ❗Обновление до версии 2.0
  • Документация
    • 🆕С чего начать
      • Регистрация и вход
      • Создаем каталоги и записи
      • Формируем отчёты
      • Настраиваем правовую политику
      • Применяем автоматизации
    • ⚙️Конструктор данных
      • Отделы
      • Каталоги
        • Редактирование структуры
        • Настройка отображения
        • Поиск и фильтрация
        • Импорт записей
          • 📗Импорт из Excel
        • Экспорт записей
        • Активность
      • Системные каталоги
        • Сотрудники
        • События
        • Внешние запросы
        • Сценарии
        • Процессы
        • Доступ к сервисам
        • Вебхуки
      • Виды
      • Записи
    • 📊Отчеты
      • Графики
    • 🔑Права
      • Правила
      • Привилегии
      • Правовые группы
      • Правовые виды
      • Права на поля
      • Комбинация прав
    • 🤖Автоматизации
      • События
        • Изменение данных
        • Внешние запросы
      • Сценарии
        • Компоненты
          • Начало процесса
          • Конец процесса
          • Таймер
          • Ошибка
          • Шлюз «ИЛИ» (условное ветвление)
          • Шлюз «И» (распараллеливание)
          • Получить запись
          • Найти записи
          • Изменить запись
          • Создать запись
          • Удалить запись
          • Структура каталога
          • Загрузить файл
          • Сгенерировать документ
          • Назначение переменных
          • Код (Javascript)
          • Веб-запрос
          • SQL-запрос
          • Конвертер
          • Парсер
          • Запуск процесса
          • Получение почты
          • Отправка почты
          • Соединяющая линия
          • Отправить сообщение
        • Переменные
        • Выражения
        • Входные и выходные параметры компонентов
        • Примеры настройки
          • Условие
          • Цикл
      • Ограничения
  • Лицензии
    • 🌐Тип лицензирования
  • Примеры
    • 🔑Права доступа к данным
    • 🤖Автоматизации
      • Выгрузка файлов на Яндекс Диск
      • Отправка на больничный
      • Автоматизация оплаты счетов
      • Создание наименований записей
      • Расчет скидок для клиентов
      • Запрет на создание дубликатов в каталоге
      • Автозаполнение данных по ИНН
      • Переброс данных между связанными каталогами
      • Очередь сценариев
      • Отслеживание заявок с сайта помощью UTM-меток
      • Просрочка задач по дедлайну
      • Реализация механизма согласования записей
      • Массовое изменение записей
      • Создание каталога для рассылки почты
      • Перенос данных между системами Бипиума
      • Импорт данных из Excel
      • Генерация счет-фактуры
      • Генерация excel-отчетов
      • Планировщик задач
      • Импорт банковских выписок
      • Производственный календарь
      • Складской учет
  • Интеграции
    • 🥂Методы интеграции
      • Интеграция данных
        • API
        • Вебхуки (webhooks)
      • Интеграция интерфейса
        • Веб-формы
        • Веб-расширения
      • Примеры интеграций
        • Тильда
          • Прием данных с формы Tilda
          • Интеграция веб-интерфейса в Tilda
        • Интеграция с сервисом «DaData»
        • Интеграция c «Единой информационной системой в сфере закупок»
        • Мессенджеры
          • Интеграция с Telegram-ботом
        • Почтовые сервисы
          • UniSender
          • MailChimp
        • Сервисы Google
          • Google Calendar
        • Телефония
          • Oktell
            • Панель телефонии Oktell
            • Компонент Bpium в Oktell
        • 1C
    • 🔌API
      • Данные
        • Каталоги (Catalogs)
        • Записи (Records)
        • Связи (Relations)
        • Истории (Histories)
        • Файлы (Files)
        • Отделы (Sections)
        • Виды (Views)
        • Сообщения (Messages)
      • Агрегация
        • Разложения (Values)
        • Сводка (Totals)
      • Отчеты
        • Дашборды (Boards)
        • Графики (Widgets)
      • Поисковые выборки
        • Доступные связи (AvailableRecords)
        • Доступные условия фильтра (AvailableFilterRecords)
        • Сотрудники (Users)
        • Контакты (Contacts)
      • Права (Rights)
      • Профиль (Profile/me)
  • Установка на сервер
    • 🧱Архитектура
      • Варианты разворачивания
    • 🖥️Требования
    • 📂Установка как служба
    • 🛳️Установка через Docker
    • 🎛️Мультидоменная среда
    • 🆘Материалы
      • TLS/SSL Сертификат
      • Параметры config.env
        • Для Bpium
        • Для Bpium S3
        • Для Bpium BPM
      • Запуск
      • Обсуживание
        • Активация
        • Обновление
        • Бэкап и восстановление базы
        • Брендирование (Whitelabel)
        • Удаление
      • Перенос базы из облака
      • Возможные проблемы в ходе установки и работы
  • Обучение
    • Базовый курс
      • Урок 1. Отделы
      • Урок 2. Каталоги с данными
      • Урок 3. Карточки записей
      • Урок 4. Связи между данными
      • Урок 5. Фильтры и виды
      • Урок 6. Приглашение сотрудников
      • Урок 7. Права доступа к данным
      • Урок 8. Графические отчеты
      • Урок 9. Бизнес-процессы
      • Урок 10. Интеграции
    • Технический курс
      • Урок 1. Принцип работы автоматизаций
      • Урок 2. Первая автоматизация изнутри
      • Урок 3. Валидация данных
      • Урок 4. Простые вычисления
      • Урок 5. Расчет суммы заказа
      • Урок 6. Генерация счетов/документов
      • Урок 7. Рассылка почтовых сообщений
      • Урок 8. Прием внешних данных
      • Урок 9. Отправка данных на сторонние сервисы
    • Паттерны проектирования ИС
      • Унификация
      • Упорядоченность
      • Разделение
      • Актуализация
      • Вынос параметров
      • Выделение позиций
      • Слияние
      • Дублирование
      • Типизация
      • Информирование
Powered by GitBook
On this page
  • Скачать файл
  • Прикрепление файла к записи
  • Прикрепление ссылки на внешней файл
  • Загрузка файла в файловое хранилище Bpium
  1. Интеграции
  2. API
  3. Данные

Файлы (Files)

Ресурс File — для скачивания загруженных файлов.

Скачать файл

URL: {domain}/api/v1/files/{fileId}

Метод: GET

Параметры:

  • fileId: (number) — идентификатор файла

Вернет редирект на ссылку на скачивание контента файла.

Ответ: 302

Заголовок:

Location: https://server.with.files.domain/url/to/file?tokenParma=tokenValue

Прикрепление файла к записи

Файлы, прикрепленные к записям могут быть прикреплены 2 способами:

  • Прикрепление внешнего файла — файл хранится на внешнем источнике, запись в каталоге содержит файл-ссылку на реальный файл на внешнем источнике.

  • Загрузка файла в хранилище — файл загружается и хранится в файловом хранилище Bpium, к записи в каталоге прикрепляется ссылка на файл в файлом хранилище Bpium.

Прикрепление ссылки на внешней файл

Чтобы прикрепить ссылку на внешний файл к записи каталога, нужно создать/сохранить запись каталога, указав ссылку на файл и его параметры в поле типа «Файл». Пример:

{
    "values": {
        "16": [{ // поле файл
            "title": "bpium_logo.png", // название файла
            "src": "https://..." // ссылка на файл
            "size": "8513", // размер файла
            "mimeType": "image/png" // MIME-тип файла
        }]
    }
}

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

Загрузка файла и прикрепление к записи ссылки на него происходит в несколько этапов:

1. Получение ключей доступа к хранилищу

Необходимо выполнить POST-запрос к ресурсу файл, для создания файла:

URL: {domain}/api/v1/files/

Метод: POST

Параметры:

  • fileId: (number) — идентификатор файла

Параметры запроса (JSON):

{
    "catalogId": "38", // ID каталога с записью, к которой будет прикреплен файл
    "recordId": "123", // ID записи, к которой будет прикреплен файл. Если для новой записи, то параметр должен отсутствовать
    "fieldId": "2", // ID поля каталога
    "name": "favicon16_drugmedia.png", // имя файла
    "size": 2900, // размер файла
    "mimeType": "image/png", // MIME-тип файла
    "typeStorage": "remoteStorage" // обязательный параметр
}

Ответ: 200

Возвращаемое значение (JSON):

        {
                "fileId": 531, // ID созданного файла
                "uploadUrl": "...", // URL хранилища файлов
                "redirect": "...",
                "acl": "private",
                "fileKey": "3/517227d3-6ccc-4c4e-8c0d-35bec5bc62f8/file.png", // путь к файлу в хранилище
                "AWSAccessKeyId": "...", // идентификатор доступа
                "police": "...", // код доступа
                "signature": "..." // подпись к коду доступа
        }

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

2. Загрузка файла в хранилище

Необходимо выполнить POST-запрос к хранилищу файлов:

URL: {uploadUrl из предыдущего запроса}

Метод: POST

Параметры запроса:

key="fileKey из предыдущего запроса"&
acl="private"&
AWSAccessKeyId="AWSAccessKeyId из предыдущего запроса"&
Policy="police(!!!, не policy) из предыдущего запроса"&
Signature="signature из предыдущего запроса"&
Content-Type="mimeType файла"&
file=бинарное содержимое загружаемого файла

Обратите внимание на параметр Content-Type: multipart/form-data. Он должен обязательно присутствовать в запросе.

Ответ: 204

3. Подтверждение загрузки файла

Необходимо отправить запрос серверу API о том, что файл загружен.

URL: {domain}/api/v1/files/{fileId из ответа 1-го запроса}

Метод: PATCH

Параметры запроса (body/JSON):

{
	"fileId": Number, // ID созданного файла
	"name": String, // имя файла
	"size": Number, // размер файла
	"mimeType": String, // MIME-тип файла
	"url": String // путь к файлу в хранилище
}

Ответ: 200

Возвращаемое значение (body/JSON):

{
	"id": Number, // ID созданного файла
	"title": String, // имя файла
	"size": Number, // размер файла
	"url": String, // путь к файлу в хранилище
	"mimeType": String, // MIME-тип файла
	"metadata": { // Метаданные: 
		"preview": String, // ссылка на предпросмотр файла
		"thumbnail": String // ссылка на миниатюру файла
	}
}

4. Прикрепление файла к записи

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

{
    "values": {
        "16": [{ // поле файл
            "id": 531 // ID созданного файла из запроса шага 1
        }]
    }
}
PreviousИстории (Histories)NextОтделы (Sections)

Last updated 1 year ago

Подробнее по работе с полями записей в статье «».

После загрузки файла, он появится в системе и файлом хранилище, но не будет связан с записью каталога и её полем анкеты, пока не будет сохранена эта запись. Чтобы сохранить запись, нужно сделать запрос к API Бипиума на :

Подробнее по работе с полями записей в статье «».

🔌
Записи (Records)
Записи (Records)
сохранение записи