الوثائق

خدمات التطبيقات

مسارات تكامل سطح المكتب وعمليات المشروع المتعقبة والإشعارات وسجلات الاشتراك الفوري.

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

ساحة التجربة

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

غير متصل

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

كيف يعمل هذا

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

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

العمليات

10 نقاط نهاية في misc المجموعة التي تم إنشاؤها من السايدكار مستند OpenAPI. تأخذ العمليات المحمية Authorization: Bearer $CADCAMFUN_TOKEN; يرى المصادقة. السلوك والحدود موجودة دليل النظام الفرعي.

بريد	/api/push-subscription	misc.pushSubscribe
يمسح	/api/push-subscription	misc.pushUnsubscribe
بريد	/api/app-control/notify	misc.notify
بريد	/api/desktop/auth/signin	misc.desktopSignin
يحصل	/api/desktop/projects	misc.desktopProjects
بريد	/api/desktop/projects	misc.desktopCreateProject
يحصل	/api/desktop/user/by-email	misc.desktopUserByEmail
يحصل	/api/projects/tracked/{id}	misc.trackedGet
يضع	/api/projects/tracked/{id}	misc.trackedUpdate
يمسح	/api/projects/tracked/{id}	misc.trackedRemove

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

كتلة واحدة لكل عملية (10)، مكدسة لكل قسم موارد في هذه الصفحة وملونة حسب الطريقة: GET الأخضر، POST البرتقالي، PUT الأزرق، PATCH البنفسجي، DELETE الأحمر. تم إنشاؤها من مستند OpenAPI في وقت الإنشاء.

/api/push-subscription

بريد /api/push-subscription # misc.pushSubscribe

يتطلب Authorization: Bearer <token>.

نص الطلب · مطلوب · application/json

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

الردود

200 هدف application/json

{
  success: true
  id: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

مثال 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-subscription

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

جربه

هيئة الطلب application/json

يمسح /api/push-subscription # misc.pushUnsubscribe

يتطلب Authorization: Bearer <token>.

نص الطلب · مطلوب · application/json

{
  endpoint?: string | null
}

الردود

200 هدف application/json

{
  success: true
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

مثال 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

حذف /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

جربه

هيئة الطلب application/json

/api/app-control/notify

بريد /api/app-control/notify # misc.notify

يتطلب Authorization: Bearer <token>.

نص الطلب · مطلوب · application/json

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

الردود

200 هدف application/json

{
  success: true
  message: string
}

400 NotifyBadRequestEncoded application/json

NotifyBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 NotifyInternalEncoded application/json

NotifyInternalEncoded

مثال 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

نشر /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

جربه

هيئة الطلب application/json

/api/desktop/auth

بريد /api/desktop/auth/signin # misc.desktopSignin

يتطلب Authorization: Bearer <token>.

نص الطلب · مطلوب · application/json

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

الردود

200 هدف 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 سطح المكتب غير مصرح به مشفرة | غير مصرح به مشفرة application/json

DesktopUnauthorizedEncoded | UnauthorizedEncoded

500 DesktopInternalEncoded application/json

DesktopInternalEncoded

مثال 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

جربه

هيئة الطلب application/json

/api/desktop/projects

يحصل /api/desktop/projects # misc.desktopProjects

يتطلب Authorization: Bearer <token>.

الردود

200 هدف 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

رد المثال تم الالتقاط · 200

الحصول على /api/desktop/projects

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

مثال 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

الحصول على /api/desktop/projects

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

جربه

بريد /api/desktop/projects # misc.desktopCreateProject

يتطلب Authorization: Bearer <token>.

نص الطلب · مطلوب · application/json

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

الردود

201 هدف 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

مثال 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

جربه

هيئة الطلب application/json

/api/desktop/user

يحصل /api/desktop/user/by-email # misc.desktopUserByEmail

يتطلب Authorization: Bearer <token>.

حدود

اسم	في	يكتب	مطلوب
بريد إلكتروني	استفسار	خيط \| null	خياري

الردود

200 هدف 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

رد المثال تم الالتقاط · 400

احصل على /api/desktop/user/by-email

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

مثال 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

احصل على /api/desktop/user/by-email

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

جربه

بريد إلكتروني استفسار

/api/projects/tracked

يحصل /api/projects/tracked/{id} # misc.trackedGet

يتطلب Authorization: Bearer <token>.

حدود

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

الردود

200 هدف 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

مثال 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

الحصول على /api/projects/tracked/{id}

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

جربه

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

يضع /api/projects/tracked/{id} # misc.trackedUpdate

يتطلب Authorization: Bearer <token>.

حدود

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

نص الطلب · مطلوب · application/json

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

الردود

200 هدف 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

مثال 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

ضع /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

جربه

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

هيئة الطلب application/json

يمسح /api/projects/tracked/{id} # misc.trackedRemove

يتطلب Authorization: Bearer <token>.

حدود

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

الردود

200 هدف 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

مثال 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

حذف /api/projects/tracked/{id}

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

جربه

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

المخططات

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

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
}

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

معرفات العملية لها النموذج misc.<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` سطر.