Skip to main content

​
Overview

The Sora Digital Photo Frame API provides RESTful endpoints for managing photos, folders, and slideshow functionality. The API supports both public slideshow access and protected admin operations.

​
Base URL

http://localhost:3000/api

​
API Categories

Photos API

Retrieve images for slideshow display

Folders API

Manage folder structure and contents

Authentication

Admin login and session management

Upload API

Upload and delete images (admin only)

​
Authentication

Public Endpoints - No authentication required:
  • Image retrieval for slideshow
  • Folder structure access
Protected Endpoints - Require admin session:
  • Photo upload/delete operations
  • Admin folder management

​
Response Format

{
  "success": true,
  "data": {},
  "message": "Success message"
}

​
Status Codes

  • 200 - Success
  • 400 - Bad Request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not Found
  • 500 - Server Error

​
Quick Start

1

Start server

npm start
2

Test public endpoint

curl http://localhost:3000/api/folders
3

Admin login

curl -X POST http://localhost:3000/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"password": "your-password"}'