Documentación

Usuarios

Perfiles, recursos de cuentas, claves API, registros de tokens, contraseñas y eliminación de cuentas.

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

18 endpoints en el user 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.

conseguir	/api/user/profile	user.profile
poner	/api/user/profile	user.updateProfile
conseguir	/api/user/stats	user.stats
conseguir	/api/user/components	user.components
conseguir	/api/user/projects	user.projects
conseguir	/api/user/toolpaths	user.toolpaths
conseguir	/api/user/organizations	user.organizations
conseguir	/api/user/api-keys	user.apiKeys
correo	/api/user/api-keys	user.createApiKey
borrar	/api/user/api-keys	user.revokeApiKey
borrar	/api/user/delete-account	user.deleteAccount
poner	/api/user/password	user.password
conseguir	/api/user/tokens	user.tokens
correo	/api/user/tokens	user.createToken
conseguir	/api/user/verify-change	user.verifyChange
conseguir	/api/user/git-profile	user.gitProfile
poner	/api/user/git-profile	user.updateGitProfile
conseguir	/api/user/{id}	user.byId

Operaciones de usuarios en 3D Arrastrar para orbitar · desplazarse para hacer zoom · arrastrar con el botón derecho para desplazarse

Un bloque por operación (18), 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/user/profile

conseguir /api/user/profile # user.profile

Requiere Authorization: Bearer <token>.

Respuestas

200 objeto application/json

{
  id: string
  name: string | null
  email: string | null
  image: string | null
  bio: string | null
  location: string | null
  website: string | null
  company: string | null
  title: string | null
  publicProfile: boolean
  showEmail: boolean
  createdAt: string
  _count: {
    projects: number | "Infinity" | "-Infinity" | "NaN"
  }
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de respuesta capturado · 200

OBTENER /api/usuario/perfil

{
  "id": "c942817d-0162-4291-84ff-77321d387acc",
  "name": "Local user",
  "email": "local@cadcamfun.local",
  "image": null,
  "bio": null,
  "location": null,
  "website": null,
  "company": null,
  "title": null,
  "publicProfile": true,
  "showEmail": false,
  "createdAt": "2026-10-15T04:52:06.538Z",
  "_count": {
    "projects": 0
  }
}

Ejemplo de SDK

user.profile

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

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

// no input
const result = await client.user.profile()

curl

OBTENER /api/usuario/perfil

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

Pruébalo

poner /api/user/profile # user.updateProfile

Requiere Authorization: Bearer <token>.

Cuerpo de la solicitud · requerido · multipart/form-data

{
  name?: string | null
  bio?: string | null
  location?: string | null
  website?: string | null
  company?: string | null
  title?: string | null
  publicProfile?: string | null
  showEmail?: string | null
  profileImage?: string[] | null
}

Respuestas

200 objeto application/json

{
  message: string
  user: {
    id: string
    name: string | null
    email: string | null
    image: string | null
    bio: string | null
    location: string | null
    website: string | null
    company: string | null
    title: string | null
    publicProfile: boolean
    showEmail: boolean
    updatedAt: string
  }
  name: string | null
  email: string | null
  image: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

buscar ejemplo

user.updateProfile

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

curl

PUT /api/usuario/perfil

curl --request PUT "${CADCAMFUN_URL}/api/user/profile" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: multipart/form-data" \
  --data-binary @request-body

Pruébalo

Esta operación requiere datos multiparte/formulario; Utilice el ejemplo curl o fetch.

/api/user/stats

conseguir /api/user/stats # user.stats

Requiere Authorization: Bearer <token>.

Respuestas

200 objeto application/json

{
  projectsCount: number | "Infinity" | "-Infinity" | "NaN"
  drawingsCount: number | "Infinity" | "-Infinity" | "NaN"
  toolpathsCount: number | "Infinity" | "-Infinity" | "NaN"
  componentsCount: number | "Infinity" | "-Infinity" | "NaN"
  totalDesigns: number | "Infinity" | "-Infinity" | "NaN"
  memberSince: string
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

Ejemplo de respuesta capturado · 200

OBTENER /api/usuario/estadísticas

{
  "projectsCount": 0,
  "drawingsCount": 0,
  "toolpathsCount": 0,
  "componentsCount": 0,
  "totalDesigns": 0,
  "memberSince": "2026-10-15T04:52:06.538Z"
}

Ejemplo de SDK

user.stats

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

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

// no input
const result = await client.user.stats()

curl

OBTENER /api/usuario/estadísticas

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

Pruébalo

/api/user/components

conseguir /api/user/components # user.components

Requiere Authorization: Bearer <token>.

Respuestas

200 Matriz<objeto> application/json

Array<{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  thumbnail: string | null
  projectId: string | null
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de respuesta capturado · 200

OBTENER /api/usuario/componentes

[]

Ejemplo de SDK

user.components

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

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

// no input
const result = await client.user.components()

curl

OBTENER /api/usuario/componentes

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

Pruébalo

/api/user/projects

conseguir /api/user/projects # user.projects

Requiere Authorization: Bearer <token>.

Respuestas

200 Matriz<objeto> application/json

Array<{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de respuesta capturado · 200

OBTENER /api/usuario/proyectos

[]

Ejemplo de SDK

user.projects

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

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

// no input
const result = await client.user.projects()

curl

OBTENER /api/usuario/proyectos

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

Pruébalo

/api/user/toolpaths

conseguir /api/user/toolpaths # user.toolpaths

Requiere Authorization: Bearer <token>.

Respuestas

200 Matriz<objeto> application/json

Array<{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  thumbnail: string | null
  projectId: string | null
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de respuesta capturado · 200

OBTENER /api/usuario/trayectorias de herramientas

[]

Ejemplo de SDK

user.toolpaths

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

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

// no input
const result = await client.user.toolpaths()

curl

OBTENER /api/usuario/trayectorias de herramientas

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

Pruébalo

/api/user/organizations

conseguir /api/user/organizations # user.organizations

Requiere Authorization: Bearer <token>.

Respuestas

200 Matriz<objeto> application/json

Array<{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  role: string
  userCount: number | "Infinity" | "-Infinity" | "NaN"
  projectCount: number | "Infinity" | "-Infinity" | "NaN"
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de respuesta capturado · 200

OBTENER /api/usuario/organizaciones

[]

Ejemplo de SDK

user.organizations

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

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

// no input
const result = await client.user.organizations()

curl

OBTENER /api/usuario/organizaciones

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

Pruébalo

/api/user/api-keys

conseguir /api/user/api-keys # user.apiKeys

Requiere Authorization: Bearer <token>.

Respuestas

200 Matriz<objeto> application/json

Array<{
  id: string
  name: string
  createdAt: string
  lastUsed: string | null
  expiresAt: string | null
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de respuesta capturado · 200

OBTENER /api/usuario/claves-api

[]

Ejemplo de SDK

user.apiKeys

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

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

// no input
const result = await client.user.apiKeys()

curl

OBTENER /api/usuario/claves-api

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

Pruébalo

correo /api/user/api-keys # user.createApiKey

Requiere Authorization: Bearer <token>.

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

{
  name?: unknown | null
}

Respuestas

201 objeto application/json

{
  message: string
  apiKey: string
  name: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de SDK

user.createApiKey

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

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

// UserCreateApiKeyInput
const result = await client.user.createApiKey({
  name: null
})

curl

POST /api/usuario/claves-api

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

Pruébalo

Cuerpo de la solicitud application/json

borrar /api/user/api-keys # user.revokeApiKey

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
keyId	consulta	cadena \| null	opcional

Respuestas

200 objeto application/json

{
  message: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de SDK

user.revokeApiKey

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

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

// UserRevokeApiKeyInput
const result = await client.user.revokeApiKey({})

curl

ELIMINAR /api/usuario/claves-api

curl --request DELETE "${CADCAMFUN_URL}/api/user/api-keys" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Pruébalo

keyId consulta

/api/user/delete-account

borrar /api/user/delete-account # user.deleteAccount

Requiere Authorization: Bearer <token>.

Respuestas

200 objeto application/json

{
  message: string
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de SDK

user.deleteAccount

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

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

// no input
const result = await client.user.deleteAccount()

curl

ELIMINAR /api/usuario/eliminar-cuenta

curl --request DELETE "${CADCAMFUN_URL}/api/user/delete-account" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Pruébalo

/api/user/password

poner /api/user/password # user.password

Requiere Authorization: Bearer <token>.

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

{
  currentPassword?: string | null
  newPassword?: string | null
}

Respuestas

200 objeto application/json

{
  message: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de SDK

user.password

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

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

// UserPasswordInput
const result = await client.user.password({
  currentPassword: "",
  newPassword: ""
})

curl

PUT /api/usuario/contraseña

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

Pruébalo

Cuerpo de la solicitud application/json

/api/user/tokens

conseguir /api/user/tokens # user.tokens

Requiere Authorization: Bearer <token>.

Respuestas

200 objeto application/json

{
  tokens: Array<{
    id: string
    name: string
    prefix: string
    permissions: string[]
    createdAt: string
    lastUsed?: string | null
    expiresAt?: string | null
    isActive: boolean
  }>
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

Ejemplo de respuesta capturado · 200

OBTENER /api/usuario/tokens

{
  "tokens": [
    {
      "id": "token-1",
      "name": "Development Token",
      "prefix": "cad_dev_abc123",
      "permissions": [
        "read:projects",
        "write:drawings",
        "read:toolpaths"
      ],
      "createdAt": "2026-10-08T04:52:23.364Z",
      "lastUsed": "2026-10-15T03:52:23.364Z",
      "isActive": true
    },
    {
      "id": "token-2",
      "name": "Mobile App Token",
      "prefix": "cad_mobile_xyz789",
      "permissions": [
        "read:projects",
        "write:toolpaths"
      ],
      "createdAt": "2026-10-01T04:52:23.364Z",
      "lastUsed": "2026-10-15T01:52:23.364Z",
      "expiresAt": "2026-11-14T04:52:23.364Z",
      "isActive": true
    },
    {
      "id": "token-3",
      "name": "Analytics Integration",
      "prefix": "cad_analytics_def456",
      "permissions": [
        "read:analytics",
        "read:usage"
      ],
      "createdAt": "2026-09-24T04:52:23.364Z",
      "expiresAt": "2026-10-14T04:52:23.364Z",
      "isActive": false
    }
  ]
}

Ejemplo de SDK

user.tokens

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

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

// no input
const result = await client.user.tokens()

curl

OBTENER /api/usuario/tokens

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

Pruébalo

correo /api/user/tokens # user.createToken

Requiere Authorization: Bearer <token>.

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

{
  name?: string | null
  permissions?: unknown | null
  expiresIn?: number | "Infinity" | "-Infinity" | "NaN" | null
}

Respuestas

201 objeto application/json

{
  token: {
    id: string
    name: string
    prefix: string
    permissions: string[]
    createdAt: string
    lastUsed?: string | null
    expiresAt?: string | null
    isActive: boolean
  }
  fullToken: string
}

400 TokenBadRequestEncoded application/json

TokenBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

Ejemplo de SDK

user.createToken

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

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

// UserCreateTokenInput
const result = await client.user.createToken({
  name: "",
  permissions: null,
  expiresIn: 0
})

curl

POST /api/usuario/tokens

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

Pruébalo

Cuerpo de la solicitud application/json

/api/user/verify-change

conseguir /api/user/verify-change # user.verifyChange

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
simbólico	consulta	cadena \| null	opcional
tipo	consulta	cadena \| null	opcional
contraseña	consulta	cadena \| null	opcional

Respuestas

200 objeto application/json

{
  message: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de respuesta capturado · 400

OBTENER /api/usuario/verificar-cambio

{
  "_tag": "BadRequest",
  "message": "Token and verification type are required"
}

Ejemplo de SDK

user.verifyChange

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

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

// UserVerifyChangeInput
const result = await client.user.verifyChange({})

curl

OBTENER /api/usuario/verificar-cambio

curl --request GET "${CADCAMFUN_URL}/api/user/verify-change" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Pruébalo

simbólico consulta tipo consulta contraseña consulta

/api/user/git-profile

conseguir /api/user/git-profile # user.gitProfile

Requiere Authorization: Bearer <token>.

Respuestas

200 objeto application/json

{
  name: string
  email: string
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

buscar ejemplo

user.gitProfile

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

curl

OBTENER /api/usuario/git-profile

curl --request GET "${CADCAMFUN_URL}/api/user/git-profile" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Pruébalo

poner /api/user/git-profile # user.updateGitProfile

Requiere Authorization: Bearer <token>.

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

{
  name: string
  email: string
}

Respuestas

200 objeto application/json

{
  name: string
  email: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

buscar ejemplo

user.updateGitProfile

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

curl

PUT /api/usuario/git-profile

curl --request PUT "${CADCAMFUN_URL}/api/user/git-profile" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Pruébalo

Cuerpo de la solicitud application/json

/api/user

conseguir /api/user/{id} # user.byId

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Respuestas

200 objeto application/json

{
  id: string
  name: string | null
  email: string | null
  image: string | null
  createdAt: string
  organizations: Array<{
    id: string
    name: string
    role: string
  }>
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Ejemplo de SDK

user.byId

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

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

// UserByIdInput
const result = await client.user.byId({
  id: "<id>"
})

curl

OBTENER /api/usuario/{id}

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

Pruébalo

identificación camino · requerido

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.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

KeyedInternalEncoded

{
  _tag: "KeyedInternal"
  error: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

TokenBadRequestEncoded

{
  _tag: "TokenBadRequest"
  error: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Llamando a este grupo

Los identificadores de operación tienen la forma user.<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.