ドキュメント

コンパニオンペアリング

デスクトップゲートウェイの状態、有効化/無効化、デバイスのペアリング、デバイスの取り消し。

英語から自動翻訳されています。英語の原文を見る

プレイグラウンド

これらのリクエストを独自の実行中のサイドカーに送信します。値はこのブラウザ内に残ります。

接続されていません

ベースURL 無記名トークン オプション セッショントークン オプション

仕組み

サイドカーは起動時に選択されたループバックポートをリッスンし、それをそのポートに出力します。 ready ライン;その URL を使用し、 CADCAMFUN_TOKEN で始まりました。リクエストはこのページからそのアドレスに直接送信されます。

サイドカーは CORS ヘッダーを Tauri オリジンと http://localhost または http://127.0.0.1 どのポートでも。ホストされているドキュメントからはブラウザーが応答をブロックするため、ドキュメントをローカルで実行します (bun run dev で packages/web) プレイグラウンドを使用するか、リクエストをcurlとしてコピーします。実際のデータに触れることなく実験するには、次のようにしてサイドカーを開始します。 CADCAMFUN_DATA_DIR 使い捨てディレクトリを指す - を参照 aPI のチュートリアル.

運営

5 エンドポイント（ companion サイドカー自体から生成されたグループ OpenAPIドキュメント。保護された操作には時間がかかります Authorization: Bearer $CADCAMFUN_TOKEN;見る認証。行動と制限は次のとおりですサブシステムガイド.

得る	/api/companion	companion.status
役職	/api/companion/enable	companion.enable
役職	/api/companion/disable	companion.disable
役職	/api/companion/pair	companion.pair
消去	/api/companion/devices/{id}	companion.revoke

3D でのコンパニオンペアリング操作ドラッグして周回します · スクロールしてズーム · 右ドラッグしてパンします

オペレーションごとに 1 つのブロック (5)、このページのリソースセクションごとにスタックされ、メソッドごとに色分けされます: 緑色の GET、オレンジ色の POST、青色の PUT、紫色の PATCH、赤色の DELETE。ビルド時に OpenAPI ドキュメントから生成されます。

/api/companion

得る /api/companion # companion.status

必要 Authorization: Bearer <token>.

応答

200 物体 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

応答例捕獲 · 200

GET /api/companion

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

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

GET /api/companion

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

試してみてください

/api/companion/enable

役職 /api/companion/enable # companion.enable

必要 Authorization: Bearer <token>.

リクエスト本文 · 必須 · application/json

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

応答

200 物体 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の例

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

試してみてください

リクエストボディ application/json

/api/companion/disable

役職 /api/companion/disable # companion.disable

必要 Authorization: Bearer <token>.

応答

200 物体 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の例

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

試してみてください

/api/companion/pair

役職 /api/companion/pair # companion.pair

必要 Authorization: Bearer <token>.

リクエスト本文 · 必須 · application/json

{
  name: string
  host?: string | null
}

応答

201 物体 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の例

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

試してみてください

リクエストボディ application/json

/api/companion/devices

消去 /api/companion/devices/{id} # companion.revoke

必要 Authorization: Bearer <token>.

パラメータ

名前	で	タイプ	必須
iD	パス	弦	必須

応答

200 物体 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の例

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

/api/companion/devices/{id} を削除します

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

試してみてください

iD パス・必須

スキーマ

このグループのパラメータ、本体、および応答から到達可能な名前付きスキーマ。あ ? オプションのフィールドをマークします。 | null null 値が存在する可能性があるフィールドにマークを付けます。

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

このグループに電話をかける

オペレーション ID の形式は次のとおりです。 companion.<name>。生成された Promise SDK (@cadcamfun/api/sdk) それらのほとんどを次のように公開します client.<namespace>.<method>(input)、どこ input パスパラメータとボディフィールドの 1 つのフラットオブジェクトです。各カードの SDK の例は、正確なアクセサーと入力タイプを示しています。マルチパートアップロード、バイナリまたは JavaScript 応答、生の Webhook は生成されません。それらのカードが示しているのは fetch 代わりに。

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

トラブルシューティング

症状	考えられる原因	修理
呼び出しごとの 401	以前の起動からのトークン、または欠落しています `Bearer` 接頭辞	送信 `Authorization: Bearer <token>` サイドカーが開始されたトークンを使用します。
何も起きる前の 400	本体またはパラメータがスキーマと一致しません	ペイロードとカード上のリクエストスキーマを比較します。
別の場所で見えるレコードの 403 または 404	代理アカウントは異なります	権利を送信します `x-session-token`、またはレコードを所有するローカルプロファイルを使用します。
409	重複した名前や古いブランチヘッドなどの矛盾した状態	リソースを再読み込みし、現在のデータで再試行します。
「CORS によってブロックされました」と表示されてみてください	ドキュメントは非ループバックオリジンから提供されます	ドキュメントをローカルで実行するか、リクエストをcurlとしてコピーします。
接続拒否	サイドカーが新しいポートで再起動されました	新しいポートからポートを読み取ります `ready` 行。