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

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

Технический справочник по интеграциям Deckbase, API и руководствам для разработчиков.

Справочник

Быстрые ссылки

Быстрый старт

curl -X POST https://www.deckbase.co/api/mcp \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'

Замени YOUR_ACCESS_TOKEN на OAuth-токен с твоей страницы Connect. Инструкции по настройке смотри в руководстве по настройке MCP.

Обзор API

Deckbase предлагает два пути интеграции: MCP-сервер для управления колодами и карточками с помощью ИИ и прямые эндпоинты REST API для программного доступа.

  • Создание, обновление и удаление колод и карточек пакетами
  • Генерация ИИ-аудио и изображений для карточек через ElevenLabs и модели изображений
  • Экспорт полных данных колоды, включая снимки блоков и метаданные
  • Создание пользовательских шаблонов с гибкой компоновкой блоков
  • Получение событий вебхуков об изменениях колод и карточек

С чего начать

Лучшие практики

Относись к созданию карточек как к операционному конвейеру

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

Определи одну каноническую стратегию шаблонов

Для команд определи одну каноническую стратегию шаблонов и одну политику повторных попыток. Это помогает избежать дублирования и дрейфа промптов и значительно ускоряет реакцию на инциденты при изменении правил маппинга.

Соблюдай рекомендуемый порядок чтения

Сначала страница настройки, затем справочник по MCP-серверу, потом проверки перед запуском в продакшене. Этот путь сводит к минимуму ошибки аутентификации и несоответствия схем при создании карточек.

Документируй правила в своём репозитории

Если ты внедряешь командные процессы, документируй правила шаблонов и критерии приёмки пакетов прямо в своём репозитории, чтобы будущие обновления оставались согласованными.

Проводи еженедельный операционный обзор

Проверяй недавние сбои записи, дрейф шаблонов и долю дублирующихся промптов перед масштабированием автоматизации.

Версионируй свой чек-лист интеграции

Веди версии чек-листа интеграции, чтобы новым участникам не приходилось восстанавливать предыдущие решения по настройке MCP методом обратной разработки.

Добавь инструкцию по откату

Когда это возможно, добавляй краткую инструкцию по откату и повторной обработке неудачных пакетов, чтобы обновления в продакшене оставались безопасными даже при изменении шаблонов.

Частые вопросы

Руководства и статьи смотри в разделе Ресурсы