Документация

Траектории проекта

Список и создание траекторий инструмента в рамках проекта с конвертами ответов для конкретных конечных точек.

Автоматически переведено с английского. Смотреть оригинал на английском

Песочница

Отправьте эти запросы на свою работающую сайдкар. Значения остаются в этом браузере.

Не подключено

Базовый URL Токен на предъявителя необязательный Токен сеанса необязательный

Как это работает

Сайдкар прослушивает порт обратной связи, выбранный при запуске, и печатает его в своем ready линия; используйте этот URL-адрес и CADCAMFUN_TOKEN с этого началось. Запросы идут прямо с этой страницы на этот адрес.

Sidecar отправляет заголовки CORS только источникам Tauri и http://localhost или http://127.0.0.1 в любом порту. Из размещенных документов браузер блокирует ответ, поэтому запускайте документы локально (bun run dev в packages/web), чтобы использовать игровую площадку, или скопируйте запрос как завиток. Чтобы поэкспериментировать, не затрагивая реальные данные, запустите сайдкар с помощью CADCAMFUN_DATA_DIR указал на одноразовый каталог — см. пошаговое руководство по API.

Операции

2 endpoint в projectToolpaths группа, созданная на основе собственной сайдкара документ OpenAPI. Защищенные операции занимают Authorization: Bearer $CADCAMFUN_TOKEN; видеть аутентификация. Поведение и ограничения находятся в руководство по подсистеме.

получать	/api/projects/{id}/toolpaths	projectToolpaths.list
почта	/api/projects/{id}/toolpaths	projectToolpaths.create

Операции с траекториями проекта в 3D Перетащите на орбиту · прокрутите, чтобы увеличить · перетащите вправо, чтобы панорамировать

Один блок на операцию (2), сгруппированный в каждом разделе ресурсов на этой странице и окрашенный в зависимости от метода: зеленый GET, оранжевый POST, синий PUT, фиолетовый PATCH, красный DELETE. Создается из документа OpenAPI во время сборки.

/api/projects

получать /api/projects/{id}/toolpaths # projectToolpaths.list

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
projectId	запрос	нить \| null	необязательный

Ответы

200 объект application/json

{
  success: true
  data: unknown | null
  message?: string | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

Пример SDK

projectToolpaths.list

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

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

// ProjectToolpathsListInput
const result = await client.projectToolpaths.list({
  id: "<id>"
})

curl

ПОЛУЧИТЕ /api/projects/{id}/toolpaths

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

Попробуйте это

идентификатор путь · требуется projectId запрос

почта /api/projects/{id}/toolpaths # projectToolpaths.create

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
projectId	запрос	нить \| null	необязательный

Тело запроса · обязательно · приложение/json

{
  name?: string | null
  description?: string | null
  data?: unknown | null
  gcode?: string | null
  projectId?: string | null
  type?: string | null
  operationType?: string | null
  isPublic?: boolean | null
  thumbnail?: string | null
  materialId?: string | null
  machineConfigId?: string | null
  toolId?: string | null
  simulation?: unknown | null
  baseUpdatedAt?: string | null
}

Ответы

200 объект application/json

{
  success: true
  data: unknown | null
  message?: string | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

взять пример

projectToolpaths.create

// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/projects/${id}/toolpaths`, {
  method: "POST",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

curl

POST /api/projects/{id}/траектории инструментов

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/toolpaths" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется projectId запрос

Тело запроса application/json

Схемы

Именованные схемы, доступные из параметров, тел и ответов этой группы. А ? отмечает необязательное поле; | null отмечает поле, которое может иметь нулевое значение.

EnvBadRequestEncoded

{
  _tag: "EnvBadRequest"
  success: false
  message: string
  errors: unknown | null
}

EnvForbiddenEncoded

{
  _tag: "EnvForbidden"
  success: false
  message: string
  errors: unknown | null
}

EnvInternalEncoded

{
  _tag: "EnvInternal"
  success: false
  message: string
  errors: unknown | null
}

EnvMethodNotAllowedEncoded

{
  _tag: "EnvMethodNotAllowed"
  success: false
  message: string
  errors: unknown | null
}

EnvNotFoundEncoded

{
  _tag: "EnvNotFound"
  success: false
  message: string
  errors: unknown | null
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Звонок в эту группу

Идентификаторы операций имеют вид projectToolpaths.<name>. Сгенерированный Promise 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».	Документы подаются из источника без обратной связи.	Запустите документы локально или скопируйте запрос как curl.
В соединении отказано	Сайдкар перезапустилась в новом порту	Прочтите порт из нового `ready` строка.