Добро пожаловать в документацию Quote3D! ⏳

Руководство по быстрому старту 🚀

Начните работу с Quote3D API менее чем за 5 минут! Для внешних интеграций вызывайте эндпоинты по адресу https://api.quote3d.com/v2. Следуйте этим шагам, чтобы создать учетную запись, сгенерировать API-токен и начать выполнять свои первые API-вызовы.

1

Создание учетной записи

  1. Перейдите на панель управления Quote3D, чтобы зарегистрировать новую учетную запись
  2. Заполните форму регистрации, указав свои данные
  3. Проверьте свою электронную почту и перейдите по ссылке подтверждения, чтобы полностью активировать свою учетную запись

Убедитесь, что вы подтвердили свой адрес электронной почты, иначе ваша учетная запись не будет полностью активирована, и вы не сможете получить доступ к API!

2

Сгенерируйте свой API-токен

  1. Войдите в свою учетную запись Quote3D
  2. Перейдите на панель управления – вы будете автоматически перенаправлены сюда после входа в систему
  3. Нажмите на вкладку "Токены" в левой боковой панели
  4. Создайте новый токен, нажав кнопку "Новый токен"
  5. Настройте свой токен
    • Дайте ему описательное имя (например, "Мой первый токен")
    • Установите срок действия в днях (оставьте поле пустым, чтобы не устанавливать срок действия)
  6. Немедленно скопируйте сгенерированный токен и храните его в безопасном месте

Вы увидите токен только один раз! Убедитесь, что скопировали и сохранили его в безопасном месте перед закрытием всплывающего окна.

3

Аутентификация с помощью API

  1. Перейдите на площадку API по адресу /docs/playground
  2. Нажмите на значок замка в правом верхнем углу
  3. Вставьте ваш JWT токен из Шага 2 в поле авторизации
  4. Нажмите Authorize

🎉 Поздравляем! Вы успешно аутентифицированы и готовы изучать Quote3D API.

4

Сделайте свой первый API-вызов

Готовы проверить? Попробуйте загрузить свой первый STL-файл:

  1. Найдите эндпоинт POST https://api.quote3d.com/v2/file в документации API
  2. Разверните вкладку, чтобы увидеть детали POST-запроса
  3. Загрузите STL-файл с помощью кнопки "Choose file", чтобы открыть проводник файлов
  4. Выполните запрос

В ответе будет включен ID файла, который вы можете использовать для:

  • Проверки размеров и возможности печати
  • Генерации коммерческих предложений для автоматированной мгновенной оценки стоимости
  • Управления загруженным файлом для экономии места в вашем облачном хранилище

`file_id` является вашим ключом для управления и ссылки на загруженные файлы в последующих API-вызовах. Это уникальный идентификатор, используемый во всех последующих запросах к API.

Дерево выбора эндпоинтов

Используйте этот краткий путь, чтобы решить, какой эндпоинт вызвать следующим на https://api.quote3d.com/v2.

  1. Нужно загружать файлы с вашего бэкенда? Используйте POST https://api.quote3d.com/v2/file с вашим Bearer-токеном.
  2. Нужна прямая загрузка через браузер без раскрытия вашего токена? Получите ID загрузки с помощью GET https://api.quote3d.com/v2/file/upload-id, затем выполните загрузку через POST https://api.quote3d.com/v2/file/public/{upload_id}.
  3. Нужна проверка размеров/соответствия перед расчетом стоимости? Выполните POST-запрос к https://api.quote3d.com/v2/printability/{file_id}.
  4. Нужен расчет стоимости? Начните с POST https://api.quote3d.com/v2/file/quote/{file_id}.
  5. Ожидание завершения расчета стоимости? Опрашивайте GET https://api.quote3d.com/v2/jobs/{job_id} до получения статусов COMPLETED, FAILED или CANCELLED.
  6. Нужна история/детали сохраненных расчетов? Используйте GET https://api.quote3d.com/v2/quotes и GET https://api.quote3d.com/v2/quotes/{quote_id}.

Примечание: Если в запросах на расчет стоимости не указаны данные о технологии, принтере или материале, API использует настройки вашего профиля пользователя по умолчанию.

Распространенные ошибки и дальнейшие действия

Быстрые действия для наиболее распространенных граничных случаев.

429: Превышен лимит запросов: Прочитайте заголовки X-RateLimit-* и Retry-After, подождите, затем повторите попытку с экспоненциальной задержкой.

Неверный формат файла: Загружайте только STL, 3MF или OBJ. Переэкспортируйте модель и проверьте целостность файла.

Модель не помещается на платформу: Сначала выполните проверку возможности печати, уменьшите масштаб модели или выберите профиль принтера с большим объемом печати.

Предупреждение: аномалия единиц измерения: Вероятно, ваша модель использует масштаб в дюймах или метрах. Переэкспортируйте её в миллиметрах (мм) и повторите попытку.

Что дальше?

Теперь, когда вы настроены, изучите эти ключевые функции:

  • Управление файлами — загружайте, скачивайте и управляйте вашими 3D-моделями (STL, 3MF, OBJ)
  • Проверка печатаемости - Убедитесь, что ваши модели соответствуют размерам вашего принтера
  • Генерация расчёта стоимости — получите мгновенную цену в предпочитаемой вами валюте с подробным расчётом использования материала и оценкой времени печати
  • История расчётов стоимости — получите доступ ко всем вашим прошлым расчётам стоимости и управляйте ими
  • Веб-хуки - Получайте уведомления в режиме реального времени о завершении коммерческих предложений и загрузке файлов
  • Аналитика - Отслеживайте ваше использование, популярные материалы и тенденции затрат
  • Управление аккаунтом - Отслеживайте ваши квоты, статистику использования и детали подписки

Важно: Все API-эндпоинты требуют аутентификации с использованием вашего Bearer токена. Обязательно включайте его в заголовок Authorization каждого запроса.

Пример: Authorization: Bearer YOUR_TOKEN_HERE

Нужна помощь? Ознакомьтесь с нашим руководством по основным концепциям или изучите API Playground для интерактивной документации.