Usługa plików

Usługa Files Service umożliwia przesyłanie plików, aby można było odwoływać się do nich w żądaniach API Altium 365. Typowym zastosowaniem jest przesłanie pliku (na przykład eksportu biblioteki komponentów), a następnie przekazanie zwróconego identyfikatora pliku do mutacji API, która akceptuje plik jako dane wejściowe.

Przesyłanie pliku

Wyślij żądanie multipart/form-data POST do punktu końcowego files, podając token dostępu w nagłówku Authorization. Treść odpowiedzi zawiera identyfikator pliku.

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)

Przekaż file_id do odpowiedniej mutacji API jako odwołanie do pliku. Informacje o tym, które mutacje akceptują identyfikatory plików, znajdziesz w schemacie API.

Punkty końcowe

Ścieżka przesyłania jest /File/Upload dołączona do bazowego adresu URL usługi files service. Pełną listę bazowych adresów URL Workspace i adresów regionalnych znajdziesz w sekcji Altium 365 API Endpoints.