Служба файлов

Краткий обзор

Узнайте, как загружать файлы в файловую службу Altium 365 и использовать полученные идентификаторы файлов в мутациях API, принимающих файлы в качестве входных данных. В статье приведены примеры на cURL и Python, описаны конечная точка для загрузки и требования к аутентификации, а также важные правила работы с идентификаторами файлов. Читайте дальше, чтобы применить эти примеры в своих запросах к API.

- Загружайте файлы с помощью POST-запроса в формате multipart/form-data, используя свой токен доступа.
- Передавайте полученный идентификатор файла в совместимую мутацию API.
- Узнайте о 24-часовом периоде доступности файлов и о том, почему не следует разбирать или формировать их идентификаторы самостоятельно.
Узнайте больше с ИИ:

Сервис файлов позволяет загружать файлы, чтобы на них можно было ссылаться в запросах к API Altium 365. Типичный сценарий использования — загрузка файла (например, экспортированной библиотеки компонентов) и последующая передача полученного идентификатора файла в мутацию API, принимающую файл в качестве входных данных.

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

Отправьте POST-запрос multipart/form-data к конечной точке сервиса файлов, указав токен доступа в заголовке Authorization. Тело ответа содержит идентификатор файла.

curl:

curl --location 'https://{workspace-domain}/api/files/File/Upload' \
  --header 'Authorization: Bearer {your-access-token}' \
  --form 'file=@"components.zip"'

Python:

import requests

token = "your-access-token"
file_path = "components.zip"

with open(file_path, "rb") as f:
    response = requests.post(
        "https://{workspace-domain}/api/files/File/Upload",
        files={"file": (file_path, f, "application/zip")},
        headers={"Authorization": f"Bearer {token}"}
    )

file_id = response.text
print(file_id)

Передайте file_id в соответствующую мутацию API в качестве ссылки на файл. Сведения о том, какие мутации принимают идентификаторы файлов, см. в схеме API.

  • File IDs are temporary. Загруженный файл доступен в течение 24 часов с момента последнего обращения к нему. По истечении этого срока файл необходимо загрузить повторно.

  • Treat the file ID as opaque. Его формат может измениться — не разбирайте и не формируйте его самостоятельно.

Конечные точки

Путь для загрузки — /File/Upload, добавленный к базовому URL-адресу сервиса файлов. Полный список базовых URL-адресов рабочих пространств и регионов см. в разделе Конечные точки API Altium 365.

AI-LocalizedЛокализовано с помощью ИИ
Если вы обнаружили проблему, выделите текст/изображение и нажмитеCtrl + Enter, чтобы отправить нам свой отзыв.
Contents
Contents