Dokumentation

Begleiterpaarung

Desktop-Gateway-Status, Aktivierung/Deaktivierung, Gerätekopplung und Gerätesperre.

Automatisch aus dem Englischen übersetzt. Englisches Original ansehen

Playground

Senden Sie diese Anfragen an Ihren eigenen laufenden Sidecar. Werte bleiben in diesem Browser.

Nicht verbunden

Basis-URL Inhabertoken optional Sitzungstoken optional

Wie das funktioniert

Der Sidecar lauscht an einem beim Start ausgewählten Loopback-Port und gibt ihn dort aus ready linie; Verwenden Sie diese URL und die CADCAMFUN_TOKEN es wurde damit begonnen. Anfragen gehen direkt von dieser Seite an diese Adresse.

Der Sidecar sendet CORS-Header nur an die Tauri-Ursprünge und an http://localhost oder http://127.0.0.1 auf jedem Port. Von den gehosteten Dokumenten aus blockiert der Browser die Antwort, also führen Sie die Dokumente lokal aus (bun run dev in packages/web), um den Spielplatz zu nutzen, oder kopieren Sie die Anfrage als Curl. Um zu experimentieren, ohne echte Daten zu berühren, starten Sie den Sidecar mit CADCAMFUN_DATA_DIR zeigte auf ein Wegwerfverzeichnis – siehe die API-Komplettlösung.

Operationen

5 Endpunkte in der companion gruppe, generiert aus der eigenen Gruppe des Sidecars OpenAPI-Dokument. Geschützte Operationen dauern Authorization: Bearer $CADCAMFUN_TOKEN; sehen authentifizierung. Verhalten und Grenzen sind in das Subsystemhandbuch.

erhalten	/api/companion	companion.status
post	/api/companion/enable	companion.enable
post	/api/companion/disable	companion.disable
post	/api/companion/pair	companion.pair
löschen	/api/companion/devices/{id}	companion.revoke

Companion-Pairing-Operationen in 3D Zum Orbit ziehen · zum Zoomen scrollen · zum Schwenken mit der rechten Maustaste ziehen

Ein Block pro Vorgang (5), gestapelt pro Ressourcenabschnitt dieser Seite und nach Methode gefärbt: grün GET, orange POST, blau PUT, violett PATCH, rot DELETE. Wird zur Erstellungszeit aus dem OpenAPI-Dokument generiert.

/api/companion

erhalten /api/companion # companion.status

Erfordert Authorization: Bearer <token>.

Antworten

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

Beispielantwort erfasst · 200

GET /api/companion

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

SDK-Beispiel

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

GET /api/companion

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

Probieren Sie es aus

/api/companion/enable

post /api/companion/enable # companion.enable

Erfordert Authorization: Bearer <token>.

Anforderungstext · erforderlich · application/json

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

Antworten

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

SDK-Beispiel

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

Probieren Sie es aus

Anforderungstext application/json

/api/companion/disable

post /api/companion/disable # companion.disable

Erfordert Authorization: Bearer <token>.

Antworten

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

SDK-Beispiel

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}"

Probieren Sie es aus

/api/companion/pair

post /api/companion/pair # companion.pair

Erfordert Authorization: Bearer <token>.

Anforderungstext · erforderlich · application/json

{
  name: string
  host?: string | null
}

Antworten

201 objekt 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

SDK-Beispiel

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

Probieren Sie es aus

Anforderungstext application/json

/api/companion/devices

löschen /api/companion/devices/{id} # companion.revoke

Erfordert Authorization: Bearer <token>.

Parameter

Name	In	Typ	Erforderlich
ausweis	weg	zeichenfolge	erforderlich

Antworten

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

SDK-Beispiel

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

LÖSCHEN /api/companion/devices/{id}

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

Probieren Sie es aus

ausweis pfad · erforderlich

Schemata

Benannte Schemata, die über die Parameter, Körper und Antworten dieser Gruppe erreichbar sind. A ? markiert ein optionales Feld; | null markiert ein Feld, das möglicherweise mit einem Nullwert vorhanden ist.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Ich rufe diese Gruppe an

Vorgangs-IDs haben die Form companion.<name>. Das generierte Promise SDK (@cadcamfun/api/sdk) entlarvt die meisten von ihnen als client.<namespace>.<method>(input), wo input ist ein flaches Objekt aus Pfadparametern und Körperfeldern; Das SDK-Beispiel jeder Karte zeigt den genauen Zugriffs- und Eingabetyp. Mehrteilige Uploads, Binär- oder JavaScript-Antworten und unformatierte Webhooks werden nicht generiert; Diese Karten zeigen fetch stattdessen.

Fehler vom Promise SDK

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
  }
}

Fehlerbehebung

Symptom	Wahrscheinliche Ursache	Fix
401 bei jedem Aufruf	Token von einem früheren Start oder fehlt `Bearer` präfix	Schicken `Authorization: Bearer <token>` mit dem Token wurde der Sidecar gestartet.
400 bevor etwas passiert	Text oder Parameter stimmen nicht mit dem Schema überein	Vergleichen Sie die Nutzlast mit dem Anforderungsschema auf der Karte.
403 oder 404 bei einem Datensatz, den du woanders siehst	Das amtierende Konto ist unterschiedlich	Schicken Sie das Richtige `x-session-token`, oder verwenden Sie das lokale Profil, das Eigentümer des Datensatzes ist.
409	Widersprüchlicher Status, z. B. ein doppelter Name oder ein veralteter Zweigkopf	Lesen Sie die Ressource erneut und versuchen Sie es erneut mit den aktuellen Daten.
Versuchen Sie es mit der Meldung „Von CORS blockiert“.	Die Dokumente werden von einem Nicht-Loopback-Ursprung bereitgestellt	Führen Sie die Dokumente lokal aus oder kopieren Sie die Anfrage als Curl.
Verbindung abgelehnt	Der Sidecar wurde an einem neuen Port neu gestartet	Lesen Sie den Port neu `ready` Zeile.