Référence API

Sovrium expose une API REST complète pour gérer les tables, enregistrements, vues, journaux d’activité, analytiques et authentification. Tous les endpoints acceptent et retournent du JSON.

Accès anticipé

L’API est en cours d’évolution. Les endpoints peuvent changer avant la v1.0.

Explorateur interactif d’API

Testez les endpoints directement dans votre navigateur avec l’explorateur interactif Scalar.

Ouvrir l’explorateur interactif↗

URL de base

Tous les endpoints sont relatifs à l’URL de base de votre instance Sovrium.

Text 
http://localhost:3000/api

Santé

Endpoint de vérification de l’état du serveur.

GET/api/health

Vérifier l’état du serveur

Tables

Consultez les définitions de tables, y compris les schémas de champs et les règles de permissions.

GET/api/tables

Lister toutes les tables

GET/api/tables/{tableId}

Obtenir une table par ID

GET/api/tables/{tableId}/permissions

Obtenir les permissions d’une table

Enregistrements

CRUD complet, opérations par lot, cycle de vie de suppression douce, historique des révisions et commentaires.

CRUD

GET/api/tables/{tableId}/records

Lister les enregistrements

POST/api/tables/{tableId}/records

Créer un enregistrement

GET/api/tables/{tableId}/records/{recordId}

Obtenir un enregistrement par ID

PATCH/api/tables/{tableId}/records/{recordId}

Modifier un enregistrement

DELETE/api/tables/{tableId}/records/{recordId}

Supprimer un enregistrement (soft)

Opérations par lot

POST/api/tables/{tableId}/records/batch

Créer plusieurs enregistrements

PATCH/api/tables/{tableId}/records/batch

Modifier plusieurs enregistrements

DELETE/api/tables/{tableId}/records/batch

Supprimer plusieurs enregistrements (soft)

POST/api/tables/{tableId}/records/upsert

Créer ou modifier un enregistrement

Corbeille & Historique

GET/api/tables/{tableId}/trash

Lister les enregistrements supprimés

POST/api/tables/{tableId}/records/{recordId}/restore

Restaurer un enregistrement

POST/api/tables/{tableId}/records/batch/restore

Restaurer plusieurs enregistrements

GET/api/tables/{tableId}/records/{recordId}/history

Obtenir l’historique des révisions

Commentaires

GET/api/tables/{tableId}/records/{recordId}/comments

Lister les commentaires d’un enregistrement

POST/api/tables/{tableId}/records/{recordId}/comments

Ajouter un commentaire

GET.../{recordId}/comments/{commentId}

Obtenir un commentaire par ID

PATCH.../{recordId}/comments/{commentId}

Modifier un commentaire

DELETE.../{recordId}/comments/{commentId}

Supprimer un commentaire

Vues

Vues préconfigurées qui filtrent, trient et regroupent les enregistrements d’une table.

GET/api/tables/{tableId}/views

Lister les vues d’une table

GET/api/tables/{tableId}/views/{viewId}

Obtenir une vue par ID

GET/api/tables/{tableId}/views/{viewId}/records

Obtenir les enregistrements via une vue

Activité

Journal d’audit des modifications sur toutes les tables.

GET/api/activity

Lister les entrées d’activité

GET/api/activity/{activityId}

Obtenir le détail d’une activité

Analytiques

Analytiques d’utilisation respectueuses de la vie privée, sans cookies.

POST/api/analytics/collect

Enregistrer un événement de page vue

GET/api/analytics/overview

Obtenir l’aperçu analytique

GET/api/analytics/pages

Obtenir les pages les plus vues

GET/api/analytics/referrers

Obtenir les principaux référents

GET/api/analytics/devices

Obtenir la répartition par appareil

GET/api/analytics/campaigns

Obtenir les statistiques de campagnes

Authentification

Gérée par Better Auth avec 28+ endpoints pour connexion, inscription, sessions, OAuth, 2FA et gestion des utilisateurs.

L’authentification est gérée par Better Auth et inclut la connexion email/mot de passe, les fournisseurs OAuth, la gestion des sessions, la réinitialisation de mot de passe, la vérification d’email, l’authentification à deux facteurs et les endpoints d’administration. Consultez la documentation de configuration ou explorez tous les endpoints dans l’explorateur interactif.

Configuration Auth →Voir tous les endpoints auth dans l’explorateur ↗

Fonctionnalités transversales

Capacités qui s’appliquent à tous les endpoints de l’API.

PaginationSoft DeletesRBACRate LimitingField-Level PermissionsOpenAPI 3.1

Schéma OpenAPI

Téléchargez la spécification OpenAPI 3.1 pour l’utiliser avec n’importe quel client API ou générateur de code.

Terminal 
curl https://your-instance.com/docs/openapi.json
Télécharger openapi.json↗
AnalytiquesJSON Schema