Documentazione

Servizi applicativi

Percorsi di integrazione desktop, operazioni di progetto monitorate, notifiche e record di sottoscrizione push.

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

10 endpoint nel misc 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/push-subscription	misc.pushSubscribe
eliminare	/api/push-subscription	misc.pushUnsubscribe
inviare	/api/app-control/notify	misc.notify
inviare	/api/desktop/auth/signin	misc.desktopSignin
ottenere	/api/desktop/projects	misc.desktopProjects
inviare	/api/desktop/projects	misc.desktopCreateProject
ottenere	/api/desktop/user/by-email	misc.desktopUserByEmail
ottenere	/api/projects/tracked/{id}	misc.trackedGet
mettere	/api/projects/tracked/{id}	misc.trackedUpdate
eliminare	/api/projects/tracked/{id}	misc.trackedRemove

Operazioni dei servizi applicativi in 3D Trascina per orbitare · scorri per ingrandire · trascina con il tasto destro per eseguire la panoramica

Un blocco per operazione (10), 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/push-subscription

inviare /api/push-subscription # misc.pushSubscribe

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

{
  endpoint?: string | null
  keys?: {
    p256dh?: string | null
    auth?: string | null
  } | null
}

Risposte

200 oggetto application/json

{
  success: true
  id: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

misc.pushSubscribe

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

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

// MiscPushSubscribeInput
const result = await client.misc.pushSubscribe({
  endpoint: "",
  keys: {}
})

curl

POST /api/push-abbonamento

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

Provalo

Richiedi corpo application/json

eliminare /api/push-subscription # misc.pushUnsubscribe

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

{
  endpoint?: string | null
}

Risposte

200 oggetto application/json

{
  success: true
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

misc.pushUnsubscribe

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

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

// MiscPushUnsubscribeInput
const result = await client.misc.pushUnsubscribe({
  endpoint: ""
})

curl

ELIMINA /api/push-subscription

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

Provalo

Richiedi corpo application/json

/api/app-control/notify

inviare /api/app-control/notify # misc.notify

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

{
  userId?: string | null
  message?: unknown | null
}

Risposte

200 oggetto application/json

{
  success: true
  message: string
}

400 NotifyBadRequestEncoded application/json

NotifyBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 NotifyInternalEncoded application/json

NotifyInternalEncoded

Esempio dell'SDK

misc.notify

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

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

// MiscNotifyInput
const result = await client.misc.notify({
  userId: "",
  message: null
})

curl

POST /api/app-control/notify

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

Provalo

Richiedi corpo application/json

/api/desktop/auth

inviare /api/desktop/auth/signin # misc.desktopSignin

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

{
  email?: string | null
  password?: string | null
  deviceId?: string | null
  platform?: string | null
}

Risposte

200 oggetto application/json

{
  success: true
  token: string
  user: {
    id: string
    name: string | null
    email: string | null
    image: string | null
  }
  syncData: {
    lastSync: string
    version: string
  }
}

400 DesktopBadRequestEncoded application/json

DesktopBadRequestEncoded

401 DesktopNon autorizzatoCodificato | NonautorizzatoCodificato application/json

DesktopUnauthorizedEncoded | UnauthorizedEncoded

500 DesktopInternalEncoded application/json

DesktopInternalEncoded

Esempio dell'SDK

misc.desktopSignin

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

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

// MiscDesktopSigninInput
const result = await client.misc.desktopSignin({
  email: "",
  password: "",
  deviceId: "",
  platform: ""
})

curl

POST /api/desktop/auth/signin

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

Provalo

Richiedi corpo application/json

/api/desktop/projects

ottenere /api/desktop/projects # misc.desktopProjects

Richiede Authorization: Bearer <token>.

Risposte

200 oggetto application/json

{
  success: true
  data: Array<{
    id: string
    name: string
    description: string | null
    owner_id: string
    organization_id: string | null
    is_public: boolean
    created_at: string
    updated_at: string
  }>
  message: string
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 DesktopInternalEncoded application/json

DesktopInternalEncoded

Risposta di esempio catturato · 200

OTTIENI /api/desktop/projects

{
  "success": true,
  "data": [],
  "message": "Retrieved 0 projects"
}

Esempio dell'SDK

misc.desktopProjects

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.misc.desktopProjects()

curl

OTTIENI /api/desktop/projects

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

Provalo

inviare /api/desktop/projects # misc.desktopCreateProject

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

{
  name?: unknown | null
  description?: string | null
  organization_id?: string | null
  is_public?: boolean | null
}

Risposte

201 oggetto application/json

{
  success: true
  data: {
    id: string
    name: string
    description: string | null
    owner_id: string
    organization_id: string | null
    is_public: boolean
    created_at: string
    updated_at: string
  }
  message: string
}

400 DesktopBadRequestEncoded application/json

DesktopBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

409 DesktopConflictEncoded application/json

DesktopConflictEncoded

500 DesktopInternalEncoded application/json

DesktopInternalEncoded

Esempio dell'SDK

misc.desktopCreateProject

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

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

// MiscDesktopCreateProjectInput
const result = await client.misc.desktopCreateProject({
  name: null,
  description: "",
  organization_id: "",
  is_public: false
})

curl

POST /api/desktop/projects

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

Provalo

Richiedi corpo application/json

/api/desktop/user

ottenere /api/desktop/user/by-email # misc.desktopUserByEmail

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
e-mail	domanda	corda \| null	opzionale

Risposte

200 oggetto application/json

{
  success: true
  data: {
    id: string
    name: string | null
    email: string | null
    image: string | null
    created_at: string
    updated_at: string
  }
  message: string
}

400 DesktopBadRequestEncoded application/json

DesktopBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 DesktopNotFoundEncoded application/json

DesktopNotFoundEncoded

500 DesktopInternalEncoded application/json

DesktopInternalEncoded

Risposta di esempio catturato · 400

OTTIENI /api/desktop/utente/via-e-mail

{
  "_tag": "DesktopBadRequest",
  "success": false,
  "error": "Email parameter is required"
}

Esempio dell'SDK

misc.desktopUserByEmail

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

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

// MiscDesktopUserByEmailInput
const result = await client.misc.desktopUserByEmail({})

curl

OTTIENI /api/desktop/utente/via-e-mail

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

Provalo

e-mail domanda

/api/projects/tracked

ottenere /api/projects/tracked/{id} # misc.trackedGet

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Risposte

200 oggetto application/json

{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  ownerId: string
  organizationId: string | null
  isPublic: boolean
  owner: {
    id: string
    name: string | null
    email: string | null
  }
  organization: {
    id: string
    name: string
  } | null
  _count: {
    drawings: number | "Infinity" | "-Infinity" | "NaN"
    components: number | "Infinity" | "-Infinity" | "NaN"
  }
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

misc.trackedGet

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

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

// MiscTrackedGetInput
const result = await client.misc.trackedGet({
  id: "<id>"
})

curl

GET /api/projects/tracked/{id}

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

Provalo

id percorso · richiesto

mettere /api/projects/tracked/{id} # misc.trackedUpdate

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Corpo della richiesta · obbligatorio · application/json

{
  name?: string | null
  description?: string | null
  organizationId?: string | null
}

Risposte

200 oggetto application/json

{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  ownerId: string
  organizationId: string | null
  isPublic: boolean
  owner: {
    id: string
    name: string | null
    email: string | null
  }
  organization: {
    id: string
    name: string
  } | null
  _count: {
    drawings: number | "Infinity" | "-Infinity" | "NaN"
    components: number | "Infinity" | "-Infinity" | "NaN"
  }
}

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

Esempio dell'SDK

misc.trackedUpdate

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

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

// MiscTrackedUpdateInput
const result = await client.misc.trackedUpdate({
  id: "<id>",
  name: "",
  description: "",
  organizationId: ""
})

curl

PUT /api/projects/tracked/{id}

curl --request PUT "${CADCAMFUN_URL}/api/projects/tracked/<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/projects/tracked/{id} # misc.trackedRemove

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Risposte

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

Esempio dell'SDK

misc.trackedRemove

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

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

// MiscTrackedRemoveInput
const result = await client.misc.trackedRemove({
  id: "<id>"
})

curl

ELIMINA /api/projects/tracked/{id}

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

Provalo

id percorso · richiesto

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.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

DesktopBadRequestEncoded

{
  _tag: "DesktopBadRequest"
  success: false
  error: string
}

DesktopConflictEncoded

{
  _tag: "DesktopConflict"
  success: false
  error: string
}

DesktopInternalEncoded

{
  _tag: "DesktopInternal"
  success: false
  error: string
}

DesktopNotFoundEncoded

{
  _tag: "DesktopNotFound"
  success: false
  error: string
}

DesktopUnauthorizedEncoded

{
  _tag: "DesktopUnauthorized"
  success: false
  error: string
}

ForbiddenEncoded

{
  _tag: "Forbidden"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

NotifyBadRequestEncoded

{
  _tag: "NotifyBadRequest"
  success: false
  error: string
}

NotifyInternalEncoded

{
  _tag: "NotifyInternal"
  success: false
  error: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Chiamando questo gruppo

Gli ID operazione hanno il formato misc.<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.