Server SDK
Préparer les services documentaires, le stockage et les droits d’accès de votre application.
Univer Server SDK fournit des modules composables. Intégrez ceux dont vous avez besoin dans votre backend, puis déployez votre application. L’authentification, les autorisations, la propriété des documents, le stockage des fichiers et l’exploitation restent à votre charge.
Cette page traite de la configuration du backend, du stockage et des autorisations. L’intégration collaborative relie l’éditeur aux documents partagés. L’intégration de l’échange de fichiers couvre le téléversement, la conversion et le téléchargement. Suivez le guide adapté à vos besoins. Pour les fonctionnalités sous licence, commencez par la configuration de la licence. L’édition uniquement dans le navigateur ne nécessite pas de service collaboratif.
Parcours d’intégration
- Quick Start : vérifier les modifications dans les deux sens avec deux contextes navigateur indépendants.
- Persistance : redémarrer SQLite et retrouver la valeur.
- Identité et droits : vérifier editor et viewer.
- Frontend métier : remplacer identité, création de documents et URL de démonstration.
- Extensions : ajouter historique, commentaires, Worktree ou Exchange après validation du socle. Pour la conversion seule, commencer par Exchange.
Choisir les services nécessaires
| Besoin | Préparation du backend | Guide |
|---|---|---|
| Édition de documents partagés | Collaboration SDK, stockage documentaire et autorisations | Démarrage rapide collaboratif |
| Import-export de fichiers Office | Conversion, téléversements, suivi des tâches et téléchargements | Conversion de fichiers et exemple Exchange |
| Historique ou commentaires partagés | Services, stockage et autorisations correspondants | Modules d’extension |
Choisissez uniquement les capacités nécessaires. La conversion seule ne nécessite pas de collaboration. Préparez l’environnement SDK et maintenez la compatibilité des versions des paquets Univer.
Connecter votre application et le stockage
Exécutez l’exemple du service choisi, puis reliez-le à votre backend. Pour les documents collaboratifs, votre application crée le document, enregistre son propriétaire et renvoie son ID au navigateur. Consultez les limites des modules pour les API de création. Votre application continue de gérer utilisateurs, projets et dossiers.
L’exemple collaboratif stocke les données en mémoire et perd le contenu au redémarrage. Suivez Adaptateurs de base de données pour connecter une base, puis vérifiez que les documents enregistrés persistent après redémarrage.
La conversion de fichiers nécessite aussi le stockage et le nettoyage des téléversements, tâches et téléchargements. Suivez l’exemple Exchange.
Connecter la connexion utilisateur et les autorisations
Suivez Identité et autorisation pour vérifier les identifiants de connexion existants et déterminer si un utilisateur peut lire ou modifier un document. Remplacez les utilisateurs fixes et les règles autorisant tout des exemples.
Protégez la lecture des documents, les connexions collaboratives, l’envoi de modifications et les fonctions activées d’historique, de commentaires et de téléchargement. Un éditeur navigateur en lecture seule ne remplace pas les contrôles serveur.
Déployer et connecter le frontend
Déployez les interfaces sur le domaine de votre application. Pour la collaboration, les proxys doivent transférer HTTP et WebSocket ; les pages HTTPS doivent utiliser WSS. Limitez les téléversements et gérez les échecs et délais de conversion. Pour passer d’une machine unique à un nœud d’import et d’export distinct puis à plusieurs nœuds de collaboration, suivez le Guide de déploiement.
Une fois le backend prêt, terminez l’intégration concernée :
- Intégration collaborative : connecter l’éditeur, créer et ouvrir les documents partagés, vérifier la synchronisation.
- Intégration de l’échange de fichiers : connecter téléversement, conversion et téléchargement, puis tester de vrais fichiers.
Que pensez-vous de ce guide ?