Огляд REST API

REST API Screenzzie дозволяє програмно керувати екранами цифрових вивісок, плейлистами, медіа та розкладами. Ідеально для інтеграцій, автоматизації та власних застосунків.

Базовий URL

Усі API ендпоінти доступні за адресою:

https://www.screenzzie.com/api/v1

Автентифікація

API використовує автентифікацію Bearer токеном з API ключами. Включіть Ваш API ключ у заголовок Authorization:

curl -X GET "https://www.screenzzie.com/api/v1/screens" \
  -H "Authorization: Bearer sk_live_your_api_key_here" \
  -H "Content-Type: application/json"

Отримання API ключа

1. Перейдіть до Налаштування > API ключі у панелі керування Screenzzie
2. Натисніть Створити API ключ
3. Виберіть описову назву та виберіть дозволи
4. Скопіюйте ключ негайно (він показується тільки один раз!)

Області дозволів API ключа

При створенні API ключа Ви можете вибрати з трьох рівнів дозволів:

Ліміти запитів

API запити обмежені на основі Вашого плану підписки:

Заголовки лімітів включені в усі відповіді:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1704067200

Формат відповіді

Усі відповіді повертаються у форматі JSON з послідовною структурою:

Успішна відповідь

{
  "success": true,
  "data": {
    // Дані ресурсу тут
  }
}

Пагінована відповідь

{
  "success": true,
  "data": {
    "items": [...],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 100,
      "totalPages": 5,
      "hasMore": true
    }
  }
}

Відповідь з помилкою

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Name is required",
    "details": { ... }
  }
}

Коди помилок

Доступні ендпоінти

API надає наступні ресурси:

• Екрани — керування екранами цифрових вивісок
• Плейлисти — створення та керування плейлистами
• Медіа — доступ та реєстрація медіафайлів
• Розклади — планування контенту (план Growth)

Наступні кроки

• Перегляньте довідник API ендпоінтів
• Створіть свій перший API ключ у панелі керування