Documentación

Almacenamiento de máquinas

Adjuntos de almacenamiento de la máquina e importación/exportación de configuración.

Traducido automáticamente del inglés. Ver el original en inglés

Área de pruebas

Envíe estas solicitudes a su propio sidecar en funcionamiento. Los valores permanecen en este navegador.

No conectado

URL base ficha al portador opcional token de sesión opcional

¿Cómo funciona esto?

El sidecar escucha en un puerto loopback elegido al inicio y lo imprime en su ready línea; use esa URL y el CADCAMFUN_TOKEN se empezó con. Las solicitudes van directamente desde esta página a esa dirección.

El sidecar envía encabezados CORS solo a los orígenes Tauri y a http://localhost o http://127.0.0.1 en cualquier puerto. Desde los documentos alojados, el navegador bloquea la respuesta, así que ejecute los documentos localmente (bun run dev en packages/web) para usar el área de juegos o copiar la solicitud como curl. Para experimentar sin tocar datos reales, inicie el sidecar con CADCAMFUN_DATA_DIR apuntado a un directorio desechable - ver el tutorial de la API.

Operaciones

5 endpoints en el machineConfigsStorage grupo, generado a partir del propio sidecar Documento OpenAPI. Las operaciones protegidas toman Authorization: Bearer $CADCAMFUN_TOKEN; ver autenticación. El comportamiento y los límites están en la guía del subsistema.

correo	/api/machine-configs/{id}/storage	machineConfigsStorage.save
conseguir	/api/machine-configs/{id}/storage	machineConfigsStorage.read
borrar	/api/machine-configs/{id}/storage	machineConfigsStorage.remove
conseguir	/api/machine-configs/export-import	machineConfigsStorage.export
correo	/api/machine-configs/export-import	machineConfigsStorage.import

Operaciones de almacenamiento de máquinas en 3D Arrastrar para orbitar · desplazarse para hacer zoom · arrastrar con el botón derecho para desplazarse

Un bloque por operación (5), apilado por sección de recursos de esta página y coloreado por método: GET verde, POST naranja, PUT azul, PATCH violeta, DELETE rojo. Generado a partir del documento OpenAPI en el momento de la compilación.

/api/machine-configs

correo /api/machine-configs/{id}/storage # machineConfigsStorage.save

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Cuerpo de la solicitud · requerido · aplicación/json

unknown

Respuestas

200 objeto 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

Ejemplo de SDK

machineConfigsStorage.save

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

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

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

curl

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

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

Pruébalo

identificación camino · requerido

Cuerpo de la solicitud application/json

conseguir /api/machine-configs/{id}/storage # machineConfigsStorage.read

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
signedUrl	consulta	cadena \| null	opcional

Respuestas

200 objeto 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

Ejemplo de SDK

machineConfigsStorage.read

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

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

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

curl

OBTENER /api/machine-configs/{id}/almacenamiento

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

Pruébalo

identificación camino · requerido signedUrl consulta

borrar /api/machine-configs/{id}/storage # machineConfigsStorage.remove

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Respuestas

200 objeto 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

Ejemplo de SDK

machineConfigsStorage.remove

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

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

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

curl

ELIMINAR /api/machine-configs/{id}/almacenamiento

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

Pruébalo

identificación camino · requerido

/api/machine-configs/export-import

conseguir /api/machine-configs/export-import # machineConfigsStorage.export

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificaciones	consulta	cadena \| cadena[] \| null	opcional
formato	consulta	cadena \| null	opcional

Respuestas

200 cualquier valor 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

Ejemplo de respuesta capturado · 404

OBTENER /api/machine-configs/export-import

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

Ejemplo de SDK

machineConfigsStorage.export

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

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

// MachineConfigsStorageExportInput
const result = await client.machineConfigsStorage.export({})

curl

OBTENER /api/machine-configs/export-import

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

Pruébalo

identificaciones consulta formato consulta

correo /api/machine-configs/export-import # machineConfigsStorage.import

Requiere Authorization: Bearer <token>.

Cuerpo de la solicitud · requerido · aplicación/json

unknown

Respuestas

200 objeto 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

Ejemplo de SDK

machineConfigsStorage.import

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

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

// MachineConfigsStorageImportInput
const result = await client.machineConfigsStorage.import({})

curl

POST /api/machine-configs/exportar-importar

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

Pruébalo

Cuerpo de la solicitud application/json

esquemas

Esquemas con nombre accesibles desde los parámetros, cuerpos y respuestas de este grupo. A ? marca un campo opcional; | null marca un campo que puede estar presente con un valor nulo.

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
}

Llamando a este grupo

Los identificadores de operación tienen la forma machineConfigsStorage.<name>. El SDK de promesa generado (@cadcamfun/api/sdk) expone la mayoría de ellos como client.<namespace>.<method>(input), dónde input es un objeto plano de parámetros de ruta y campos de cuerpo; El ejemplo de SDK de cada tarjeta muestra el acceso exacto y el tipo de entrada. No se generan cargas de varias partes, respuestas binarias o JavaScript ni webhooks sin formato; esas tarjetas muestran fetch en su lugar.

Errores del SDK de 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
  }
}

Solución de problemas

Síntoma	causa probable	Arreglar
401 en cada llamada	Token de un lanzamiento anterior o faltante `Bearer` prefijo	Enviar `Authorization: Bearer <token>` con la ficha con la que se inició el sidecar.
400 antes de que ocurra algo	El cuerpo o el parámetro no coincide con el esquema	Compare la carga útil con el esquema de solicitud en la tarjeta.
403 o 404 en un registro que puedes ver en otro sitio	La cuenta de actuación difiere.	enviar la derecha `x-session-token`o utilice el perfil local propietario del registro.
409	Estado conflictivo, como un nombre duplicado o un encabezado de sucursal obsoleto	Vuelva a leer el recurso y vuelva a intentarlo con los datos actuales.
Pruébelo, dice "bloqueado por CORS"	Los documentos se entregan desde un origen sin bucle invertido.	Ejecute los documentos localmente o copie la solicitud como curl.
Conexión rechazada	El sidecar se reinició en un nuevo puerto.	Leer el puerto del nuevo `ready` línea.