Documentation

Historique du parcours d'outil

Versions de parcours d'outils, restauration, découverte de bibliothèques et commentaires de programmes threadés.

Traduit automatiquement de l'anglais. Voir l'original en anglais

Playground

Envoyez ces demandes à votre propre sidecar en cours d’exécution. Les valeurs restent dans ce navigateur.

Non connecté

URL de base Jeton du porteur facultatif Jeton de session facultatif

Comment ça marche

Le sidecar écoute sur un port de bouclage choisi au démarrage et l'imprime dans son ready doubler; utilisez cette URL et le CADCAMFUN_TOKEN ça a commencé avec. Les demandes vont directement de cette page à cette adresse.

Le sidecar envoie les en-têtes CORS uniquement aux origines Tauri et à http://localhost ou http://127.0.0.1 sur n'importe quel port. À partir des documents hébergés, le navigateur bloque la réponse, exécutez donc les documents localement (bun run dev dans packages/web) pour utiliser le terrain de jeu, ou copiez la requête sous forme curl. Pour expérimenter sans toucher aux données réelles, démarrez le sidecar avec CADCAMFUN_DATA_DIR pointé vers un répertoire jetable — voir la procédure pas à pas de l'API.

Opérations

8 endpoints dans le toolpathExtras groupe, généré à partir du propre sidecar Document OpenAPI. Les opérations protégées prennent Authorization: Bearer $CADCAMFUN_TOKEN; voir authentification. Le comportement et les limites sont en place le guide du sous-système.

obtenir	/api/toolpaths/library	toolpathExtras.library
obtenir	/api/toolpaths/{id}/versions	toolpathExtras.listVersions
poste	/api/toolpaths/{id}/versions	toolpathExtras.createVersion
poste	/api/toolpaths/{id}/versions/restore	toolpathExtras.restoreVersion
obtenir	/api/toolpaths/{id}/comments	toolpathExtras.listComments
poste	/api/toolpaths/{id}/comments	toolpathExtras.createComment
mettre	/api/toolpaths/{id}/comments/{commentId}	toolpathExtras.updateComment
supprimer	/api/toolpaths/{id}/comments/{commentId}	toolpathExtras.removeComment

Opérations d'historique de parcours d'outil en 3D Faites glisser vers l'orbite · faites défiler pour zoomer · faites glisser vers la droite pour effectuer un panoramique

Un bloc par opération (8), empilé par section de ressources de cette page et coloré par méthode : vert GET, orange POST, bleu PUT, violet PATCH, rouge DELETE. Généré à partir du document OpenAPI au moment de la construction.

/api/toolpaths/library

obtenir /api/toolpaths/library # toolpathExtras.library

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
projectId	requête	chaîne	requis
taper	requête	chaîne \| null	facultatif
operationType	requête	chaîne \| null	facultatif
catégorie	requête	chaîne \| null	facultatif
recherche	requête	chaîne \| null	facultatif

Réponses

200 Tableau<objet> application/json

Array<{
  id: string
  name: string
  description: string
  type: string
  operationType: string
  category: string
  tags: string[]
  data: unknown
  gcode: string
  projectId: string
}>

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemple de SDK

toolpathExtras.library

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// ToolpathExtrasLibraryInput
const result = await client.toolpathExtras.library({})

curl

GET /api/toolpaths/library

curl --request GET "${CADCAMFUN_URL}/api/toolpaths/library?projectId=<projectId>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Essayez-le

projectId requête · obligatoire taper requête operationType requête catégorie requête recherche requête

/api/toolpaths

obtenir /api/toolpaths/{id}/versions # toolpathExtras.listVersions

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
identifiant	chemin	chaîne	requis

Réponses

200 Tableau<objet> application/json

Array<{
  id: string
  toolpathId: string
  data: unknown
  gcode: string | null
  changeMessage: string | null
  userId: string
  createdAt: string
  user: {
    name: string | null
    email: string | null
  } | null
}>

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemple de SDK

toolpathExtras.listVersions

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// ToolpathExtrasListVersionsInput
const result = await client.toolpathExtras.listVersions({
  id: "<id>"
})

curl

OBTENIR /api/toolpaths/{id}/versions

curl --request GET "${CADCAMFUN_URL}/api/toolpaths/<id>/versions" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Essayez-le

identifiant chemin · obligatoire

poste /api/toolpaths/{id}/versions # toolpathExtras.createVersion

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
identifiant	chemin	chaîne	requis

Corps de la requête · requis · application/json

{
  data?: unknown | null
  gcode?: string | null
  changeMessage?: string | null
}

Réponses

201 objet application/json

{
  id: string
  toolpathId: string
  data: unknown
  gcode: string | null
  changeMessage: string | null
  userId: string
  createdAt: string
  message: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemple de SDK

toolpathExtras.createVersion

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// ToolpathExtrasCreateVersionInput
const result = await client.toolpathExtras.createVersion({
  id: "<id>",
  data: null,
  gcode: "",
  changeMessage: ""
})

curl

POST /api/toolpaths/{id}/versions

curl --request POST "${CADCAMFUN_URL}/api/toolpaths/<id>/versions" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Essayez-le

identifiant chemin · obligatoire

Corps de la demande application/json

poste /api/toolpaths/{id}/versions/restore # toolpathExtras.restoreVersion

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
identifiant	chemin	chaîne	requis

Corps de la requête · requis · application/json

{
  versionId: string
}

Réponses

200 objet application/json

{
  id: string
  name: string
  description: string | null
  data: unknown
  type: string | null
  operationType: string | null
  gcode: string | null
  thumbnail: string | null
  isPublic: boolean
  projectId: string
  createdAt: string
  updatedAt: string
  createdBy: string
  drawingId: string | null
  materialId: string | null
  toolId: string | null
  machineConfigId: string | null
  message: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemple de SDK

toolpathExtras.restoreVersion

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// ToolpathExtrasRestoreVersionInput
const result = await client.toolpathExtras.restoreVersion({
  id: "<id>",
  versionId: ""
})

curl

POST /api/toolpaths/{id}/versions/restore

curl --request POST "${CADCAMFUN_URL}/api/toolpaths/<id>/versions/restore" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Essayez-le

identifiant chemin · obligatoire

Corps de la demande application/json

obtenir /api/toolpaths/{id}/comments # toolpathExtras.listComments

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
identifiant	chemin	chaîne	requis

Réponses

200 Tableau<objet> application/json

Array<{
  id: string
  toolpathId: string
  content: string
  userId: string
  createdAt: string
  updatedAt: string
  user: {
    id: string
    name: string | null
    email: string | null
    image: string | null
  } | null
}>

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemple de SDK

toolpathExtras.listComments

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// ToolpathExtrasListCommentsInput
const result = await client.toolpathExtras.listComments({
  id: "<id>"
})

curl

GET /api/toolpaths/{id}/comments

curl --request GET "${CADCAMFUN_URL}/api/toolpaths/<id>/comments" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Essayez-le

identifiant chemin · obligatoire

poste /api/toolpaths/{id}/comments # toolpathExtras.createComment

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
identifiant	chemin	chaîne	requis

Corps de la requête · requis · application/json

{
  content: string
}

Réponses

201 objet application/json

{
  id: string
  toolpathId: string
  content: string
  userId: string
  createdAt: string
  updatedAt: string
  user: {
    id: string
    name: string | null
    email: string | null
    image: string | null
  } | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemple de SDK

toolpathExtras.createComment

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// ToolpathExtrasCreateCommentInput
const result = await client.toolpathExtras.createComment({
  id: "<id>",
  content: ""
})

curl

POST /api/toolpaths/{id}/comments

curl --request POST "${CADCAMFUN_URL}/api/toolpaths/<id>/comments" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Essayez-le

identifiant chemin · obligatoire

Corps de la demande application/json

mettre /api/toolpaths/{id}/comments/{commentId} # toolpathExtras.updateComment

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
identifiant	chemin	chaîne	requis
commentId	chemin	chaîne	requis

Corps de la requête · requis · application/json

{
  content: string
}

Réponses

200 objet application/json

{
  id: string
  toolpathId: string
  content: string
  userId: string
  createdAt: string
  updatedAt: string
  user: {
    id: string
    name: string | null
    email: string | null
    image: string | null
  } | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemple de SDK

toolpathExtras.updateComment

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// ToolpathExtrasUpdateCommentInput
const result = await client.toolpathExtras.updateComment({
  id: "<id>",
  commentId: "<commentId>",
  content: ""
})

curl

PUT /api/toolpaths/{id}/comments/{commentId}

curl --request PUT "${CADCAMFUN_URL}/api/toolpaths/<id>/comments/<commentId>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Essayez-le

identifiant chemin · obligatoire commentId chemin · obligatoire

Corps de la demande application/json

supprimer /api/toolpaths/{id}/comments/{commentId} # toolpathExtras.removeComment

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
identifiant	chemin	chaîne	requis
commentId	chemin	chaîne	requis

Réponses

200 objet application/json

{
  message: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemple de SDK

toolpathExtras.removeComment

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// ToolpathExtrasRemoveCommentInput
const result = await client.toolpathExtras.removeComment({
  id: "<id>",
  commentId: "<commentId>"
})

curl

DELETE /api/toolpaths/{id}/comments/{commentId}

curl --request DELETE "${CADCAMFUN_URL}/api/toolpaths/<id>/comments/<commentId>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Essayez-le

identifiant chemin · obligatoire commentId chemin · obligatoire

Schémas

Schémas nommés accessibles à partir des paramètres, des corps et des réponses de ce groupe. UN ? marque un champ facultatif ; | null marque un champ qui peut être présent avec une valeur nulle.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

ForbiddenEncoded

{
  _tag: "Forbidden"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Appel à ce groupe

Les identifiants d'opération ont la forme toolpathExtras.<name>. Le SDK Promise généré (@cadcamfun/api/sdk) expose la plupart d'entre eux comme client.<namespace>.<method>(input), où input est un objet plat composé de paramètres de chemin et de champs de corps ; L'exemple de SDK de chaque carte montre l'accesseur exact et le type d'entrée. Les téléchargements en plusieurs parties, les réponses binaires ou JavaScript et les webhooks bruts ne sont pas générés ; ces cartes montrent fetch à la place.

Erreurs du SDK Promise

import { CadCam, ClientError } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

try {
  await client.projects.list()
} catch (error) {
  if (error instanceof ClientError) {
    // Transport | UnexpectedStatus | UnsupportedContentType | MalformedResponse | SseEventTooLarge
  } else {
    // a declared error body: switch on error._tag
  }
}

Dépannage

Symptôme	Cause probable	Réparer
401 à chaque appel	Jeton d'un lancement précédent, ou manquant `Bearer` préfixe	Envoyer `Authorization: Bearer <token>` avec le jeton avec lequel le sidecar a été démarré.
400 avant que quoi que ce soit se produise	Le corps ou le paramètre ne correspond pas au schéma	Comparez la charge utile avec le schéma de demande sur la carte.
403 ou 404 sur un enregistrement visible ailleurs	Le compte intérimaire diffère	Envoyez le droit `x-session-token`, ou utilisez le profil local propriétaire de l'enregistrement.
409	État conflictuel, tel qu'un nom en double ou un chef de succursale obsolète	Relisez la ressource et réessayez avec les données actuelles.
Essayez, il est écrit "bloqué par CORS"	Les documents sont servis à partir d'une origine sans bouclage	Exécutez la documentation localement ou copiez la demande en tant que curl.
Connexion rejetée	Le sidecar a redémarré sur un nouveau port	Lire le port du nouveau `ready` ligne.