الوثائق

الاقتران رفيق

حالة بوابة سطح المكتب، والتمكين/التعطيل، وإقران الجهاز، وإلغاء الجهاز.

مترجم تلقائيًا من الإنجليزية. عرض الأصل بالإنجليزية

ساحة التجربة

أرسل هذه الطلبات إلى السايدكار الخاصة بك. تبقى القيم في هذا المتصفح.

غير متصل

عنوان URL الأساسي رمز حامل خياري رمز الجلسة خياري

كيف يعمل هذا

يستمع السايدكار إلى منفذ الاسترجاع الذي تم اختياره عند بدء التشغيل ويطبعه في منفذ الاسترجاع الخاص به ready خط؛ استخدم عنوان URL هذا و CADCAMFUN_TOKEN لقد بدأ مع. تذهب الطلبات مباشرة من هذه الصفحة إلى هذا العنوان.

يرسل السايدكار رؤوس CORS فقط إلى أصول Tauri وإلى http://localhost أو http://127.0.0.1 على أي منفذ. من المستندات المستضافة، يحظر المتصفح الاستجابة، لذا قم بتشغيل المستندات محليًا (bun run dev في packages/web) لاستخدام الملعب، أو نسخ الطلب كحليقة. للتجربة دون لمس البيانات الحقيقية، ابدأ تشغيل السايدكار باستخدام CADCAMFUN_DATA_DIR أشار إلى دليل مهمل - انظر إرشادات واجهة برمجة التطبيقات.

العمليات

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

عمليات الاقتران المصاحبة في 3د اسحب إلى المدار · قم بالتمرير للتكبير · اسحب بزر الماوس الأيمن للتحريك

كتلة واحدة لكل عملية (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

الحصول على /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

الحصول على /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>.

حدود

اسم	في	يكتب	مطلوب
بطاقة تعريف	طريق	خيط	مطلوب

الردود

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

جربه

بطاقة تعريف المسار · مطلوب

المخططات

يمكن الوصول إلى المخططات المسماة من معلمات هذه المجموعة وأجسامها واستجاباتها. أ ? يمثل حقلاً اختياريًا؛ | null يضع علامة على الحقل الذي قد يكون موجودًا بقيمة فارغة.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

استدعاء هذه المجموعة

معرفات العملية لها النموذج companion.<name>. وعد SDK الذي تم إنشاؤه (@cadcamfun/api/sdk) يعرض معظمهم client.<namespace>.<method>(input)، أين input هو كائن مسطح واحد من معلمات المسار وحقول النص؛ يُظهر مثال SDK لكل بطاقة الملحق الدقيق ونوع الإدخال. لا يتم إنشاء التحميلات متعددة الأجزاء والاستجابات الثنائية أو استجابات JavaScript وخطافات الويب الأولية؛ تظهر تلك البطاقات 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"	يتم تقديم المستندات من أصل غير استرجاعي	قم بتشغيل المستندات محليًا أو انسخ الطلب كـ curly.
رفض اتصال	تم إعادة تشغيل السايدكار في منفذ جديد	قراءة المنفذ من الجديد `ready` سطر.