ファイルサービス

Files Service では、Altium 365 API リクエストで参照できるようにファイルをアップロードできます。一般的な用途としては、ファイル（コンポーネントライブラリのエクスポートなど）をアップロードし、返されたファイル ID を、ファイル入力を受け付ける API ミューテーションに渡すことです。

ファイルのアップロード

multipart/form-dataヘッダーにアクセストークンを含めて、files エンドポイントに POST リクエストを送信します。レスポンス本文がファイル ID です。

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 ミューテーションに渡します。どのミューテーションがファイル ID を受け付けるかについては、API スキーマを参照してください。

エンドポイント

アップロードパスは、files service のベース URL に /File/Upload を追加したものです。Workspace および各リージョンのベース URL の一覧については、Altium 365 API Endpoints を参照してください。