Service de fichiers

Le service Files vous permet de téléverser des fichiers afin qu’ils puissent être référencés dans les requêtes de l’API Altium 365. Le cas d’usage typique consiste à téléverser un fichier (par exemple, une exportation de bibliothèque de composants), puis à transmettre l’ID de fichier renvoyé à une mutation d’API qui accepte un fichier en entrée.

Téléversement d’un fichier

Envoyez une requête multipart/form-data POST au point de terminaison files avec votre jeton d’accès dans l’en-tête Authorization. Le corps de la réponse contient l’ID du fichier.

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)

Transmettez file_id à la mutation d’API concernée comme référence de fichier. Consultez le schéma de l’API pour savoir quelles mutations acceptent des ID de fichier.

Points de terminaison

Le chemin de téléversement est /File/Upload ajouté à l’URL de base du service Files. Consultez Altium 365 API Endpoints pour obtenir la liste complète des URL de base Workspace et régionales.