JsonBox — Postman collection

Коллекция Postman для работы с JsonBox — лёгким REST API для хранения JSON-данных.

Содержание репозитория

jsonbox-postman/
├─ examples/
│  └─ quickstart.md
├─ JsonBox_API_postman_collection.json
├─ LICENSE
├─ PUBLISHING.md
└─ README.md

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

1. Скачайте файл JsonBox_API_postman_collection.json (в этом репозитории он уже есть).
2. Откройте Postman (или Insomnia / Hoppscotch) → Import → выберите файл JsonBox_API_postman_collection.json.
3. Создайте окружение (Environment) и добавьте переменную api_key.
   • Для просмотра страниц (page.php) используйте read‑only ключ, начинающийся с ro_ (пример: ro_abc123...).
   • Для операций записи (store/delete/set_setting и т.п.) используйте полный api_key (необязательно для Page-view, и возможно отключён для этой фичи — см. ниже про безопасность).

Примечание: страничный просмотр (page.php) безопасно работает только с ключом только для чтения — api_key_read_only (префикс ro_). Полный ключ не будет работать для публичного веб-рендера по соображениям безопасности.

Переменные Postman

• api_key — основной placeholder, используемый в коллекции. Замените на ваш ro_... или api_key.

Для API-запросов коллекция передаёт ключ через заголовок Authorization: Bearer YOUR_API_KEY. Старый query-параметр api_key для GET-запросов поддерживается сервером для совместимости, но deprecated.

Ключевые запросы (коротко)

Сохранить данные

POST https://jsonbox.ru/api.php?action=store
Content-Type: application/json
Authorization: Bearer YOUR_FULL_API_KEY

{
  "data": { ... }
}

Получить данные

GET https://jsonbox.ru/api.php?action=get
Authorization: Bearer YOUR_API_KEY

Удалить данные

DELETE https://jsonbox.ru/api.php?action=delete
Authorization: Bearer YOUR_FULL_API_KEY

Настройки

• Получить все настройки:

GET https://jsonbox.ru/api.php?action=get_settings
Authorization: Bearer YOUR_API_KEY

• Изменить настройку (например, включить/выключить веб-отображение или поставить тему):

POST https://jsonbox.ru/api.php?action=set_setting
Content-Type: application/json
Authorization: Bearer YOUR_FULL_API_KEY

{
  "setting_name": "web_display_enabled",
  "setting_value": "false"
}

Перегенерировать ключ

POST https://jsonbox.ru/api.php?action=regenerate_key
Authorization: Bearer YOUR_FULL_API_KEY

Просмотр как веб-страницы (Pages)

https://jsonbox.ru/page.php?key=ro_YOUR_READ_ONLY_KEY&page=PAGE_SLUG

• page — необязательный параметр; если не указан — показывается первая страница из массива pages.
• Обязательно используйте ключ ro_... (read-only). Полный ключ для этой операции не используется/не поддерживается по соображениям безопасности.

Raw import

Коллекцию можно импортировать напрямую по raw URL:

https://raw.githubusercontent.com/JsonBox/jsonbox-postman/main/JsonBox_API_postman_collection.json

Как обновлять коллекцию

1. Вносите изменения локально в Postman.
2. Экспортируйте коллекцию в формате JSON.
3. Обновите файл JsonBox_API_postman_collection.json в репозитории и сделайте коммит с заметкой, что изменилось (новые endpoints / параметры).
4. По желанию добавьте changelog в README с ссылкой на релиз.

Лицензия

Файлы в этом репозитории можно распространять — в репозитории присутствует лицензия MIT (файл LICENSE).