Documentazione

Macchine

Record di configurazione della macchina, aggiornamenti, rimozione e clonazione.

Tradotto automaticamente dall'inglese. Vedi l'originale in inglese

Playground

Invia queste richieste al tuo sidecar in corsa. I valori rimangono in questo browser.

Non connesso

URL di base Gettone al portatore opzionale Token di sessione opzionale

Come funziona

Il sidecar resta in ascolto su una porta di loopback scelta all'avvio e la stampa nel suo file ready linea; usa quell'URL e il file CADCAMFUN_TOKEN è stato iniziato con. Le richieste vanno direttamente da questa pagina a quell'indirizzo.

Il sidecar invia intestazioni CORS solo alle origini Tauri e a http://localhost o http://127.0.0.1 su qualsiasi porto. Dai documenti ospitati il browser blocca la risposta, quindi esegui i documenti localmente (bun run dev in packages/web) per utilizzare il parco giochi, oppure copiare la richiesta come ricciolo. Per sperimentare senza toccare i dati reali, avvia il sidecar con CADCAMFUN_DATA_DIR indicato in una directory usa e getta - vedi la procedura dettagliata dell'API.

Operazioni

7 endpoint nel machineConfigs gruppo, generato da quello del sidecar Documento OpenAPI. Le operazioni protette richiedono Authorization: Bearer $CADCAMFUN_TOKEN; vedere autenticazione. Comportamenti e limiti sono entrati la guida del sottosistema.

ottenere	/api/machine-configs	machineConfigs.list
inviare	/api/machine-configs	machineConfigs.create
ottenere	/api/machine-configs/{id}	machineConfigs.get
mettere	/api/machine-configs/{id}	machineConfigs.update
eliminare	/api/machine-configs/{id}	machineConfigs.remove
inviare	/api/machine-configs/{id}/clone	machineConfigs.clone
ottenere	/api/machine-configs/defaults	machineConfigs.defaults

Operazioni delle macchine in 3D Trascina per orbitare · scorri per ingrandire · trascina con il tasto destro per eseguire la panoramica

Un blocco per operazione (7), impilato per sezione di risorse di questa pagina e colorato in base al metodo: verde GET, arancione POST, blu PUT, viola PATCH, rosso DELETE. Generato dal documento OpenAPI in fase di compilazione.

/api/machine-configs

ottenere /api/machine-configs # machineConfigs.list

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
pagina	domanda	corda \| null	opzionale
limite	domanda	corda \| null	opzionale
tipo	domanda	corda \| null	opzionale
ricerca	domanda	corda \| null	opzionale
pubblico	domanda	corda \| null	opzionale

Risposte

200 oggetto application/json

{
  success: true
  data: unknown | null
  message?: string | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

Risposta di esempio catturato · 200

OTTIENI /api/machine-configs

{
  "success": true,
  "data": {
    "data": [],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 0,
      "totalPages": 0
    }
  }
}

Esempio dell'SDK

machineConfigs.list

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

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

// MachineConfigsListInput
const result = await client.machineConfigs.list({})

curl

OTTIENI /api/machine-configs

curl --request GET "${CADCAMFUN_URL}/api/machine-configs" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Provalo

pagina domanda limite domanda tipo domanda ricerca domanda pubblico domanda

inviare /api/machine-configs # machineConfigs.create

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

unknown

Risposte

200 oggetto application/json

{
  success: true
  data: unknown | null
  message?: string | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

Esempio dell'SDK

machineConfigs.create

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

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

// MachineConfigsCreateInput
const result = await client.machineConfigs.create({})

curl

POST /api/machine-configs

curl --request POST "${CADCAMFUN_URL}/api/machine-configs" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Provalo

Richiedi corpo application/json

ottenere /api/machine-configs/{id} # machineConfigs.get

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Risposte

200 oggetto application/json

{
  success: true
  data: unknown | null
  message?: string | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

Esempio dell'SDK

machineConfigs.get

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

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

// MachineConfigsGetInput
const result = await client.machineConfigs.get({
  id: "<id>"
})

curl

GET /api/machine-configs/{id}

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

Provalo

id percorso · richiesto

mettere /api/machine-configs/{id} # machineConfigs.update

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Corpo della richiesta · obbligatorio · application/json

unknown

Risposte

200 oggetto application/json

{
  success: true
  data: unknown | null
  message?: string | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

Esempio dell'SDK

machineConfigs.update

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

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

// MachineConfigsUpdateInput
const result = await client.machineConfigs.update({
  id: "<id>"
})

curl

PUT /api/machine-configs/{id}

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

Provalo

id percorso · richiesto

Richiedi corpo application/json

eliminare /api/machine-configs/{id} # machineConfigs.remove

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Risposte

200 oggetto application/json

{
  success: true
  data: unknown | null
  message?: string | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

Esempio dell'SDK

machineConfigs.remove

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

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

// MachineConfigsRemoveInput
const result = await client.machineConfigs.remove({
  id: "<id>"
})

curl

ELIMINA /api/machine-configs/{id}

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

Provalo

id percorso · richiesto

inviare /api/machine-configs/{id}/clone # machineConfigs.clone

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Corpo della richiesta · obbligatorio · application/json

unknown

Risposte

200 oggetto application/json

{
  success: true
  data: unknown | null
  message?: string | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

Esempio dell'SDK

machineConfigs.clone

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

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

// MachineConfigsCloneInput
const result = await client.machineConfigs.clone({
  id: "<id>"
})

curl

POST /api/machine-configs/{id}/clone

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

Provalo

id percorso · richiesto

Richiedi corpo application/json

/api/machine-configs/defaults

ottenere /api/machine-configs/defaults # machineConfigs.defaults

Richiede Authorization: Bearer <token>.

Risposte

200 oggetto application/json

{
  success: true
  data: unknown | null
  message?: string | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

prendere esempio

machineConfigs.defaults

// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/machine-configs/defaults`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

curl

OTTIENI /api/machine-configs/defaults

curl --request GET "${CADCAMFUN_URL}/api/machine-configs/defaults" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Provalo

Schemi

Schemi denominati raggiungibili dai parametri, dai corpi e dalle risposte di questo gruppo. UN ? contrassegna un campo facoltativo; | null contrassegna un campo che può essere presente con un valore nullo.

EnvBadRequestEncoded

{
  _tag: "EnvBadRequest"
  success: false
  message: string
  errors: unknown | null
}

EnvForbiddenEncoded

{
  _tag: "EnvForbidden"
  success: false
  message: string
  errors: unknown | null
}

EnvInternalEncoded

{
  _tag: "EnvInternal"
  success: false
  message: string
  errors: unknown | null
}

EnvMethodNotAllowedEncoded

{
  _tag: "EnvMethodNotAllowed"
  success: false
  message: string
  errors: unknown | null
}

EnvNotFoundEncoded

{
  _tag: "EnvNotFound"
  success: false
  message: string
  errors: unknown | null
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Chiamando questo gruppo

Gli ID operazione hanno il formato machineConfigs.<name>. L'SDK Promise generato (@cadcamfun/api/sdk) ne espone la maggior parte come client.<namespace>.<method>(input), dove input è un oggetto piatto di parametri di percorso e campi del corpo; l'esempio dell'SDK di ciascuna scheda mostra l'esatto accessor e il tipo di input. Non vengono generati caricamenti in più parti, risposte binarie o JavaScript e webhook grezzi; quelle carte mostrano fetch invece.

Errori dall'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
  }
}

Risoluzione dei problemi

Sintomo	Probabile causa	Aggiustare
401 a ogni chiamata	Token di un lancio precedente o mancante `Bearer` prefisso	Inviare `Authorization: Bearer <token>` con il gettone con cui è stato avviato il sidecar.
400 prima che accada qualcosa	Il corpo o il parametro non corrisponde allo schema	Confronta il payload con lo schema di richiesta sulla carta.
403 o 404 su un record visibile altrove	Il resoconto della recitazione è diverso	Invia il diritto `x-session-token`oppure utilizzare il profilo locale proprietario del record.
409	Stato in conflitto, ad esempio un nome duplicato o una testa di ramo obsoleta	Rileggere la risorsa e riprovare con i dati correnti.
Prova, dice "bloccato da CORS"	I documenti vengono serviti da un'origine non di loopback	Esegui i documenti localmente o copia la richiesta come curl.
Connessione rifiutata	Il sidecar è ripartito su una nuova porta	Leggi il porto dal nuovo `ready` riga.