Documentazione

Abbinamento dei compagni

Stato del gateway desktop, attivazione/disattivazione, associazione e revoca del dispositivo.

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

5 endpoint nel companion 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/companion	companion.status
inviare	/api/companion/enable	companion.enable
inviare	/api/companion/disable	companion.disable
inviare	/api/companion/pair	companion.pair
eliminare	/api/companion/devices/{id}	companion.revoke

Operazioni di abbinamento dei compagni in 3D Trascina per orbitare · scorri per ingrandire · trascina con il tasto destro per eseguire la panoramica

Un blocco per operazione (5), 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/companion

ottenere /api/companion # companion.status

Richiede Authorization: Bearer <token>.

Risposte

200 oggetto application/json

{
  enabled: boolean
  port: number | "Infinity" | "-Infinity" | "NaN" | null
  fingerprint: string | null
  host: string
  devices: Array<{
    id: string
    name: string
    createdAt: string
    lastSeen: string | null
  }>
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Risposta di esempio catturato · 200

OTTIENI /api/companion

{
  "enabled": false,
  "port": null,
  "fingerprint": null,
  "host": "172.30.0.2",
  "devices": []
}

Esempio dell'SDK

companion.status

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.companion.status()

curl

OTTIENI /api/companion

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

Provalo

/api/companion/enable

inviare /api/companion/enable # companion.enable

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

{
  port?: number | "Infinity" | "-Infinity" | "NaN" | null
}

Risposte

200 oggetto application/json

{
  enabled: boolean
  port: number | "Infinity" | "-Infinity" | "NaN" | null
  fingerprint: string | null
  host: string
  devices: Array<{
    id: string
    name: string
    createdAt: string
    lastSeen: string | null
  }>
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

companion.enable

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

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

// CompanionEnableInput
const result = await client.companion.enable({
  port: 0
})

curl

POST /api/companion/enable

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

Provalo

Richiedi corpo application/json

/api/companion/disable

inviare /api/companion/disable # companion.disable

Richiede Authorization: Bearer <token>.

Risposte

200 oggetto application/json

{
  enabled: boolean
  port: number | "Infinity" | "-Infinity" | "NaN" | null
  fingerprint: string | null
  host: string
  devices: Array<{
    id: string
    name: string
    createdAt: string
    lastSeen: string | null
  }>
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

companion.disable

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.companion.disable()

curl

POST /api/companion/disable

curl --request POST "${CADCAMFUN_URL}/api/companion/disable" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Provalo

/api/companion/pair

inviare /api/companion/pair # companion.pair

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

{
  name: string
  host?: string | null
}

Risposte

201 oggetto application/json

{
  id: string
  link: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

companion.pair

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

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

// CompanionPairInput
const result = await client.companion.pair({
  name: "",
  host: ""
})

curl

POST /api/companion/pair

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

Provalo

Richiedi corpo application/json

/api/companion/devices

eliminare /api/companion/devices/{id} # companion.revoke

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Risposte

200 oggetto application/json

{
  enabled: boolean
  port: number | "Infinity" | "-Infinity" | "NaN" | null
  fingerprint: string | null
  host: string
  devices: Array<{
    id: string
    name: string
    createdAt: string
    lastSeen: string | null
  }>
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

companion.revoke

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

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

// CompanionRevokeInput
const result = await client.companion.revoke({
  id: "<id>"
})

curl

ELIMINA /api/companion/devices/{id}

curl --request DELETE "${CADCAMFUN_URL}/api/companion/devices/<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
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Chiamando questo gruppo

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