Panoramica
Snapp espone una REST API documentata esclusivamente tramite OpenAPI 3.1 e renderizzata con Scalar.
Non esiste documentazione duplicata, nessun esempio riscritto e nessuna specifica mantenuta a mano. Quello che vedi corrisponde esattamente a ciò che il server espone a runtime.
Il riferimento API è disponibile qui:
Cosa trovi in /api/docs
La pagina di documentazione è alimentata da Scalar e carica più sorgenti OpenAPI contemporaneamente.
API Snapp
La specifica principale documenta l’API della piattaforma Snapp, includendo:
- health check
- risoluzione degli URL accorciati
- operazioni CRUD sugli URL
- gestione dei tag
- associazioni ai team
- endpoint di metriche e analytics
Lo schema riflette:
- payload reali di richiesta e risposta
- regole di validazione effettive
- requisiti di autenticazione
- risposte di errore
Il documento OpenAPI è generato a partire dalle route live ed è servito direttamente da Snapp.
API Better-Auth
L’autenticazione è gestita da Better-Auth.
La sua specifica OpenAPI non viene duplicata né riscritta. Viene invece caricata come sorgente separata all’interno della stessa istanza Scalar.
Dalla stessa pagina /api/docs puoi passare tra:
- API Snapp
- API Better-Auth
Ogni specifica resta isolata, ma entrambe sono accessibili dalla stessa UI.
Autenticazione
Tutti gli endpoint dell’API Snapp richiedono autenticazione.
- Le richieste devono includere un token
Bearer - Il token viene validato come API key
- La chiave è associata a un host specifico
- I permessi sono applicati per organizzazione
Le richieste provenienti da origini sconosciute vengono rifiutate prima dell’autenticazione.
Risposte tipiche:
401– API key mancante o non valida403– host non riconosciuto o permessi insufficienti
Ambito di questo riferimento
Questa pagina documenta solo le API HTTP pubbliche.
Non copre intenzionalmente:
- comportamento della UI
- servizi interni
- schema del database
- job o worker in background
Se non è visibile in /api/docs, non fa parte della superficie API pubblica.
Usa l’interfaccia Scalar per esplorare gli endpoint, ispezionare gli schemi ed eseguire richieste di test contro la tua istanza Snapp.