Сервис файлов

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

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

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

curl:

curl --location 'https://{workspace-domain}/svc/napi/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}/svc/napi/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/Upload, добавленный к базовому URL сервиса files. Полный список базовых URL Workspace и региональных URL см. в разделе Altium 365 API Endpoints.