Как работает локальное и удаленное добавление файлов

В этом руководстве подробно описан весь процесс добавления файлов с использованием API-интерфейса Frame.io V4. В нем рассматриваются необработанные запросы к API-интерфейсу и ответы как для локального, так и для удаленного добавления.

Ищете руководства по конкретным SDK? Инструкции по добавлению с встроенным разделением на фрагменты, выполнением повторных попыток и отслеживанием прогресса — в руководстве по добавлению через SDK для Python.

Предварительные требования

Перед тем как приступить к добавлению файлов, убедитесь, что вы выполнили следующие шаги по настройке.

1

Учетная запись Frame.io V4

У вас есть учетная запись Frame.io V4, управляемая через Adobe Admin Console, ИЛИ вы перевели пользователей своей учетной записи на аутентификацию Adobe.

2

Настройка Adobe Developer Console

Вы вошли в Adobe Developer Console и добавили API-интерфейс Frame.io в новый или существующий проект.

3

Учетные данные для аутентификации

Вы создали соответствующие учетные данные для аутентификации в своем проекте.

4

Токен доступа

Вы успешно использовали эти учетные данные для создания токена доступа.

Выбор метода добавления

Существует два способа добавления файлов через API-интерфейс Frame.io: Создать файл (локальное добавление) и Создать файл (удаленное добавление).

Локальное добавление

Используйте этот метод, если медиафайл доступен вашему приложению локально (аналогично перетаскиванию файла с рабочего стола).

Удаленное добавление

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

В этом руководстве мы начнем с более простого случая — удаленного добавления.

Удаленное добавление

Чтобы создать файл путем удаленного добавления, выберите конечную точку Создать файл (удаленное добавление). В теле запроса необходимо передать имя файла и URL-адрес его источника.

В настоящее время для удаленного добавления установлено ограничение на размер файла 50 ГБ. Для файлов размером более 50 ГБ используйте локальное добавление.

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

1{
2 "data": {
3 "name": "my_file.jpg",
4 "source_url": "https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.jpg"
5 }
6}

Пример ответа

Успешный запрос вернет ответ, аналогичный приведенному ниже.

1{
2 "data": {
3 "id": "93e4079d-0a8a-4bf3-96cd-e6a03c465e5e",
4 "name": "my_file.jpg",
5 "status": "created",
6 "type": "file",
7 "file_size": 518,
8 "updated_at": "2025-06-26T20:14:33.796116Z",
9 "media_type": "image/jpeg",
10 "parent_id": "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
11 "project_id": "7e46e495-4444-4555-8649-bee4d391a997",
12 "created_at": "2025-06-26T20:14:33.159489Z",
13 "view_url": "https://next.frame.io/project/7e46e495-4444-4555-8649-bee4d391a997/view/93e4079d-0a8a-4bf3-96cd-e6a03c465e5e"
14 },
15 "links": {
16 "status": "/v4/accounts/6f70f1bd-7e89-4a7e-b4d3-7e576585a181/files/93e4079d-0a8a-4bf3-96cd-e6a03c465e5e/status"
17 }
18}

Локальное добавление

Чтобы создать файл путем локального добавления, выберите конечную точку Создать файл (локальное добавление). В теле запроса необходимо указать имя файла и его размер в байтах.

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

1{
2 "data": {
3 "name": "my_file.jpg",
4 "file_size": 50645990
5 }
6}

Пример ответа

В случае успешного выполнения запроса создается пустой файл-заполнитель. В зависимости от размера файла тело ответа будет содержать один или несколько URL-адресов добавления upload_urls. В данном примере нам потребуется управлять добавлением частями.

1{
2 "data": {
3 "id": "fa18ba7b-b3ee-4dd6-9b31-bd07e554241d",
4 "name": "my_file.jpg",
5 "status": "created",
6 "type": "file",
7 "file_size": 50645990,
8 "updated_at": "2025-06-26T20:08:06.823170Z",
9 "media_type": "image/jpeg",
10 "parent_id": "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
11 "project_id": "7e46e495-4444-4555-8649-bee4d391a997",
12 "created_at": "2025-06-26T20:08:06.751313Z",
13 "upload_urls": [
14 {
15 "size": 16881997,
16 "url": "https://frameio-uploads-development.s3-accelerate.amazonaws.com/parts/fa18ba7b-b3ee-4dd6-9b31-bd07e554241d/part_1?..."
17 },
18 {
19 "size": 16881997,
20 "url": "https://frameio-uploads-development.s3-accelerate.amazonaws.com/parts/fa18ba7b-b3ee-4dd6-9b31-bd07e554241d/part_2?..."
21 },
22 {
23 "size": 16881996,
24 "url": "https://frameio-uploads-development.s3-accelerate.amazonaws.com/parts/fa18ba7b-b3ee-4dd6-9b31-bd07e554241d/part_3?..."
25 }
26 ],
27 "view_url": "https://next.frame.io/project/7e46e495-4444-4555-8649-bee4d391a997/view/fa18ba7b-b3ee-4dd6-9b31-bd07e554241d"
28 }
29}

Важные требования к добавлению

Ниже приведены важные детали, которые необходимо учитывать при отправке последующих запросов на добавление.

  • Метод HTTP-запроса должен быть PUT
  • Заголовок x-amz-acl должен быть обязательно включен и иметь значение private.
  • Заголовок Content-Type должен соответствовать типу данных media_type, указанному в исходном запросе Создать файл (локальное добавление). Это правило действует даже в том случае, если файл добавляется отдельными частями. В приведенном выше примере значением media_type является image/jpeg. Соответственно, значение Content-Type также должно быть image/jpeg.

Добавление частями

Если для определенного файла создается более одного URL-адреса добавления, необходимо разделить исходный файл на фрагменты и отправить запрос PUT для каждого из них.

Рекомендация. В руководстве по добавлению с помощью SDK для Python описано добавление частями с помощью компонента FrameioUploader, который обеспечивает разделение на фрагменты, параллельное добавление, выполнение повторных попыток и отслеживание прогресса.

Если необходимо выполнить добавление вручную (например, на языке, для которого нет готового SDK, или ради полного контроля над процессом), приведенный ниже сценарий показывает, как разбить файл на фрагменты и добавить каждый из них с использованием предварительно подписанных URL-адресов.

Пример выполнения на Python

Сценарий добавления частями
1import requests
2import math
3from typing import List
4from tqdm import tqdm # For progress bar
5
6def upload_file_in_chunks(file_path: str, upload_urls: list[str], content_type: str | None = None, chunk_size: int | None = None) -> bool:
7 """
8 Upload a file in chunks using presigned URLs.
9 """
10 try:
11 # Auto-detect content type based on file extension
12 if content_type is None:
13 detected_content_type, _ = mimetypes.guess_type(file_path)
14 content_type = detected_content_type # Default fallback
15
16 print(f"Detected content type: {content_type}")
17
18 # Get file size
19 with open(file_path, 'rb') as f:
20 f.seek(0, 2) # Seek to end of file
21 file_size = f.tell()
22
23 # Calculate chunk size if not provided
24 if chunk_size is None:
25 chunk_size = math.ceil(file_size / len(upload_urls))
26
27 print(f"File size: {file_size} bytes")
28 print(f"Chunk size: {chunk_size} bytes")
29 print(f"Number of chunks: {len(upload_urls)}")
30
31 # Upload each chunk
32 with open(file_path, 'rb') as f:
33 with tqdm(total=len(upload_urls), desc="Uploading chunks") as pbar:
34 for i, url in enumerate(upload_urls):
35 start_byte = i * chunk_size
36 end_byte = min(start_byte + chunk_size, file_size)
37
38 # Read chunk from file
39 f.seek(start_byte)
40 chunk = f.read(end_byte - start_byte)
41
42 print(f"Uploading chunk {i+1}: {len(chunk)} bytes")
43
44 # Upload chunk with minimal headers matching the signature
45 response = requests.put(
46 url,
47 data=chunk,
48 headers={
49 'content-type': content_type,
50 'x-amz-acl': 'private'
51 }
52 )
53
54 if response.status_code != 200:
55 print(f"Failed to upload chunk {i+1}. Status code: {response.status_code}")
56 print(f"Response text: {response.text}")
57 print(f"Response headers: {dict(response.headers)}")
58 return False
59 else:
60 print(f"Chunk {i+1} uploaded successfully!")
61
62 pbar.update(1)
63
64 return True
65
66 except Exception as e:
67 print(f"Error during upload: {str(e)}")
68 return False
69
70# Example usage
71if __name__ == "__main__":
72 # Replace these with your actual values
73 file_path = "/Users/MyComputer/local_upload/sample.jpg" # Path to your file
74 upload_urls = [
75 "https://frameio-uploads-development.s3-accelerate.amazonaws.com/parts/fa18ba7b-b3ee-4dd6-9b31-bd07e554241d/part_1?...",
76 "https://frameio-uploads-development.s3-accelerate.amazonaws.com/parts/fa18ba7b-b3ee-4dd6-9b31-bd07e554241d/part_2?...",
77 "https://frameio-uploads-development.s3-accelerate.amazonaws.com/parts/fa18ba7b-b3ee-4dd6-9b31-bd07e554241d/part_3?..."
78 ]
79 content_type = "image/jpeg"
80
81 print("Starting file upload...")
82 success = upload_file_in_chunks(file_path, upload_urls, content_type)
83
84 if success:
85 print("File upload completed successfully!")
86 else:
87 print("File upload failed!")

Сводка процесса добавления

1

Выбор метода добавления

Выберите между удаленным добавлением (файл доступен по URL-адресу) или локальным добавлением (файл находится в вашей системе).

2

Запрос на создание файла

Выполните первичный запрос, чтобы создать ресурс для файла с необходимыми метаданными.

3

Обработка URL-адресов добавления

В случае локального добавления обработайте возвращенные URL-адреса (для одной или нескольких частей).

4

Добавление содержимого файла

Используйте запросы PUT с соответствующими заголовками для отправки содержимого файла по предоставленным URL-адресам.

5

Подтверждение добавления

Проверьте статус файла, чтобы подтвердить успешное завершение добавления и обработки.

Следующие шаги. Как только ваш файл будет добавлен, вы сможете использовать полученный идентификатор файла, чтобы оставлять комментарии, создавать общие ресурсы или выполнять другие операции, используя API-интерфейс Frame.io V4.