Documentazione

Deposito attrezzi

Dati di archiviazione e raccolta degli utensili o importazione/esportazione per utensile.

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 toolsStorage 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.

inviare	/api/tools/{id}/storage	toolsStorage.save
ottenere	/api/tools/{id}/storage	toolsStorage.read
eliminare	/api/tools/{id}/storage	toolsStorage.remove
ottenere	/api/tools/export-import	toolsStorage.export
inviare	/api/tools/export-import	toolsStorage.import
ottenere	/api/tools/{id}/export-import	toolsStorage.exportById
inviare	/api/tools/{id}/export-import	toolsStorage.importById

Operazioni di stoccaggio degli strumenti 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/tools

inviare /api/tools/{id}/storage # toolsStorage.save

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
  message: string
  data: unknown | 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

toolsStorage.save

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

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

// ToolsStorageSaveInput
const result = await client.toolsStorage.save({
  id: "<id>"
})

curl

POST /api/tools/{id}/storage

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

Provalo

id percorso · richiesto

Richiedi corpo application/json

ottenere /api/tools/{id}/storage # toolsStorage.read

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario
sentiero	domanda	corda \| null	opzionale
signedUrl	domanda	corda \| null	opzionale

Risposte

200 oggetto application/json

{
  success: true
  message: string
  data: unknown | 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

toolsStorage.read

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

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

// ToolsStorageReadInput
const result = await client.toolsStorage.read({
  id: "<id>"
})

curl

OTTIENI /api/tools/{id}/storage

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

Provalo

id percorso · richiesto sentiero domanda signedUrl domanda

eliminare /api/tools/{id}/storage # toolsStorage.remove

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario
sentiero	domanda	corda \| null	opzionale

Risposte

200 oggetto application/json

{
  success: true
  message: string
  data: unknown | 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

toolsStorage.remove

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

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

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

curl

ELIMINA /api/tools/{id}/storage

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

Provalo

id percorso · richiesto sentiero domanda

ottenere /api/tools/{id}/export-import # toolsStorage.exportById

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario
iD	domanda	corda \| corda[] \| null	opzionale
formato	domanda	corda \| null	opzionale

Risposte

200 qualsiasi valore JSON application/json

unknown

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

toolsStorage.exportById

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

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

// ToolsStorageExportByIdInput
const result = await client.toolsStorage.exportById({
  id: "<id>"
})

curl

GET /api/tools/{id}/export-import

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

Provalo

id percorso · richiesto iD domanda formato domanda

inviare /api/tools/{id}/export-import # toolsStorage.importById

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
  message: string
  data: unknown | 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

toolsStorage.importById

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

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

// ToolsStorageImportByIdInput
const result = await client.toolsStorage.importById({
  id: "<id>"
})

curl

POST /api/tools/{id}/export-import

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

Provalo

id percorso · richiesto

Richiedi corpo application/json

/api/tools/export-import

ottenere /api/tools/export-import # toolsStorage.export

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
iD	domanda	corda \| corda[] \| null	opzionale
formato	domanda	corda \| null	opzionale

Risposte

200 qualsiasi valore JSON application/json

unknown

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 · 404

GET /api/tools/export-import

{
  "_tag": "EnvNotFound",
  "success": false,
  "message": "No accessible tools found",
  "errors": null
}

Esempio dell'SDK

toolsStorage.export

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

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

// ToolsStorageExportInput
const result = await client.toolsStorage.export({})

curl

GET /api/tools/export-import

curl --request GET "${CADCAMFUN_URL}/api/tools/export-import" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Provalo

iD domanda formato domanda

inviare /api/tools/export-import # toolsStorage.import

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

unknown

Risposte

200 oggetto application/json

{
  success: true
  message: string
  data: unknown | 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

toolsStorage.import

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

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

// ToolsStorageImportInput
const result = await client.toolsStorage.import({})

curl

POST /api/tools/export-import

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

Provalo

Richiedi corpo application/json

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 toolsStorage.<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.