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

Интеграция
через API

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

Начать интеграцию Список изменений

Скриншот документации API с примерами кода и структуры JSON

Введение в API Pixly

RESTful API Pixly предоставляет программный доступ ко всем функциям платформы. Это позволяет автоматизировать создание дизайн-систем, внедрять динамические цветовые схемы в мобильные приложения и синхронизировать визуальные активы между различными средами разработки.

Все запросы отправляются к базовому URL: https://api.pixly.cloud/v2

Платформа использует стандартные HTTP-методы (GET, POST, PUT, DELETE) и работает исключительно с форматом данных JSON. Для обеспечения безопасности все соединения защищены протоколом TLS 1.3.

Получение токена доступа

Аутентификация через Bearer Token

Auth

Шаг 1: Регистрация ключа

Зайдите в раздел Settings > API Keys в личном кабинете. Нажмите Generate New Key и выберите уровень доступа (Read-only или Admin). Сохраните ключ, так как он отображается только один раз.

Header

Шаг 2: Передача заголовков

Добавьте ваш токен в заголовок каждого запроса. Пример:

          Authorization: Bearer px_live_8f92a...4b21
        

Эндпоинты генерации градиентов

Основной метод для создания визуальных активов. Вы можете задать цвета, углы и тип интерполяции (Linear, Radial, Conic).

POST /v2/gradients/generate

Пример тела запроса (Payload):

{
  "type": "linear",
  "angle": 135,
  "colors": [
    { "hex": "#FF2E93", "stop": 0 },
    { "hex": "#7000FF", "stop": 100 }
  ],
  "format": "css"
}
      

Формат ответа (JSON)

Успешные ответы возвращают статус 200 OK и объект данных. Ошибки возвращают статус 4xx или 5xx с объектом error, содержащим код ошибки и описание.

Пример ответа сервера:

{
  "status": "success",
  "data": {
    "id": "grad_882910",
    "css_string": "linear-gradient(135deg, #FF2E93 0%, #7000FF 100%)",
    "svg_url": "https://cdn.pixly.cloud/svg/grad_882910.svg",
    "created_at": "2023-10-27T10:00:00Z"
  }
}
      

Ограничения и лимиты

Параметры использования API для обеспечения стабильности

60

Запросов в минуту

10MB

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

JSON

Только JSON

429

Код при превышении

При превышении лимита (Rate Limit) сервер вернет статус 429 Too Many Requests. В заголовке ответа будет присутствовать поле Retry-After, указывающее время в секундах, через которое можно повторить запрос.

Примеры кода

Готовые сниппеты для интеграции в ваши проекты.

Python (Requests)

import requests

url = "https://api.pixly.cloud/v2/gradients/generate"
headers = {
    "Authorization": "Bearer px_live_8f92a...",
    "Content-Type": "application/json"
}
payload = {
    "type": "linear",
    "colors": ["#00F0FF", "#7000FF"]
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())
        

JavaScript (Fetch)

const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer px_live_8f92a...',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'radial',
    colors: ['#FF2E93', '#000000']
  })
};

fetch('https://api.pixly.cloud/v2/gradients/generate', options)
  .then(res => res.json())
  .then(data => console.log(data));
        

Нужна помощь с интеграцией?

Наши инженеры помогут настроить API для сложных сценариев использования.

Связаться с разработчиками

Интеграция через API