API documentation

Welcome to Panoramax API documentation ! It will help you through all phases of setup, run and develop on Panoramax API and backend.

Note

If at some point you're lost or need help, you can contact us through issues, by email or on Matrix channels.

Architecture overview

Panoramax API is the backend powering a Panoramax instance.

API

A Python API the Flask framework.
Database

A PostgreSQL database with the PostGIS extension.
Pictures Workers

For better handling of uploaded pictures, several Picture Workers can be run alongside the API, they will regularly poll the database to check for pictures to process.
🗄️ Flexible storage

Flexible storage for uploaded pictures, on files or object storage.
🔐 OAuth

Optional external OAuth2 provider to handle authentication
🙈 External blurring API

Optional external blurring API

Architecture diagram

Architecture overview

Panoramax API setup is quite flexible, deep dive in the documentation to see how to host you own Panoramax instance.

Panoramax offers a REST API to access collections (sequences), items (pictures) and their metadata.