Разработчикам

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

Интегрируйте возможности генерации UI Glyphly напрямую в ваш CI/CD пайплайн или кастомные инструменты. Наш REST API предоставляет полный контроль над компонентами, токами и конфигурацией дизайн-системы.

Аутентификация

Все запросы к API должны содержать заголовок Authorization с вашим личным токеном доступа. Токены можно сгенерировать в разделе настроек рабочего пространства.

# Пример заголовка запроса

          GET /v1/components HTTP/1.1

          Host: api.glyphly.io

          Authorization: Bearer glp_live_8f9d2a...e41b

          Content-Type: application/json

Область доступа: Для создания компонентов требуется scope write:components, для чтения — read:design.

Безопасность

Все соединения шифруются через TLS 1.3. Мы не логируем ваши токены в открытом виде. В случае компрометации ключа, мгновенно отзовите его через консоль администратора.

Справочник конечных точек

Базовый URL: https://api.glyphly.io/v1

GET /components

Возвращает список всех компонентов в активной библиотеке. Поддерживает пагинацию и фильтрацию по тегам (например, ?tag=button).

POST /generate

Принимает текстовое описание и параметры токенов. Запускает асинхронную задачу генерации. Возвращает task_id для отслеживания статуса.

PATCH /tokens/{id}

Обновляет значение дизайн-токена (цвета, шрифта, отступа). Автоматически триггерит пересборку зависимых компонентов.

Примеры кода

Генерация компонента

Вот пример того, как создать кнопку с адаптивным стилем, используя cURL или Python. API автоматически определит необходимые CSS переменные на основе вашего брендбука.

curl -X POST https://api.glyphly.io/v1/generate \
  -H "Authorization: Bearer glp_live_8f9d2a..." \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Secondary button with icon right, rounded corners",
    "framework": "react",
    "variant": "outline",
    "tokens": {
      "radius": "md",
      "font": "inter"
    }
  }'

Ответ: 202 Accepted. Компонент будет доступен в репозитории через 15-30 секунд.

Интерфейс документации API с примерами кода

Лимиты и тарифы (Rate Limits)

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

120 Запросов в минуту (GET)

30 Генераций в час (POST)

10Mb Лимит тела запроса

Коды ответов

429 Too Many Requests Вы превысили лимит. Попробуйте снова через X-RateLimit-Reset секунд.

403 Forbidden Недостаточно прав доступа для выполнения действия.

503 Service Unavailable Сервис временно недоступен. ИИ модель перегружена.

Нужен больший лимит?

Для команд с высокой нагрузкой на генерацию мы предлагаем Enterprise план с выделенными ресурсами и SLA 99.99%.

Связаться с инженером Скачать SDK