Outils de développement

Outils de développement

La section Outils de développement sert à intégrer ONLYOFFICE DocSpace dans votre application web, à utiliser le Plugin SDK, les webhooks, à ajouter des applications OAuth et des clés API.

Par défaut, l'accès à la section Outils de développement est activé pour tous les utilisateurs sauf les invités, pour que n'importe quel utilisateur puisse accéder à cette page, et en conséquence, créer ses propres webhooks ou ses propres applications OAuth 2.0, etc. Si vous souhaitez que la page Outils de développement ne soit accessible qu'au propriétaire et aux administrateurs de DocSpace, désactivez l'option Section Outils de développement dans la section Sécurité.

Embed SDK

Utilisez ONLYOFFICE DocSpace SDK basé sur JavaScript permettant aux développeurs d'utiliser toutes les possibilités de DocSpace avec api.js. Vous pouvez intégrer ONLYOFFICE DocSpace dans votre application web et donner aux utilisateurs la possibilité de créer et envoyer des documents directement depuis votre site web. Pour en savoir plus sur l'utilisation d'Embed SDK, veuillez consulter ce guide.

Pour en savoir plus sur Embed SDK, veuillez visiter api.onlyoffice.com.

Plugin SDK

Utilisez le Plugin SDK pour étendre les fonctionnalités de DocSpace, connecter des services tiers ou enrichir l'expérience utilisateur avec des fonctionnalités personnalisées. La page Plugin SDK propose également une collection d'exemples de plugins prêts à l'emploi avec le code source disponible sur GitHub.

Pour commencer à créer votre propre plugin, cliquez sur le bouton Lire les instructions sur la page Plugin SDK pour accéder à un guide pas à pas.

Exemples de plugins

La section Exemples de plugins répertorie les plugins officiellement pris en charge avec des liens vers leurs dépôts GitHub :

• codemirror — afficher et modifier des fichiers contenant du code de programmation dans de nombreux formats.
• markdown — afficher, modifier et créer des fichiers Markdown (.md) directement dans DocSpace.
• convert-to-markdown — convertir des fichiers DOCX, TXT et HTML au format Markdown sans quitter DocSpace.
• zip-archives — ouvrir et extraire des archives ZIP stockées dans DocSpace.
• speech-to-text — transcrire de l'audio en texte à l'aide de la reconnaissance vocale directement dans DocSpace.
• pdf-converter — convertir des documents, classeurs, présentations et formulaires au format PDF.
• url — créer, modifier et ouvrir des fichiers URL avec des liens externes depuis la liste de fichiers.
• book-reader — ouvrir les fichiers pris en charge dans une visionneuse de lecture dédiée en plein écran.
• draw.io — créer et modifier des diagrammes à l'aide de l'outil de diagrammes draw.io.
• image-editor — modifier des images directement dans DocSpace.

Fonctionnalités du plugin

Les plugins développés avec le Plugin SDK peuvent utiliser les fonctionnalités suivantes :

• Localisation — les plugins prennent en charge plusieurs langues via le mécanisme de localisation intégré.
• Personnalisation CSS — appliquez des styles personnalisés à l'interface de votre plugin à l'aide de CSS standard.
• Actions menu groupe — ajoutez des actions personnalisées au menu de sélection de groupe pour les fichiers, dossiers et salles.
• Sélecteurs personnalisés — affichez les sélecteurs intégrés de DocSpace (basique, fichier, salle, groupes, utilisateurs) dans votre plugin.
• Bouton d'action flottant — ajoutez des opérations personnalisées avec des icônes personnalisées au bouton d'action flottant, avec indicateur de progression.
• Emplacements barre latérale — placez des points d'entrée de plugin dans la barre latérale à l'aide d'icônes 32×32 px. Jusqu'à 5 emplacements sont disponibles.
• Actions menu contextuel — affichez des actions spécifiques au plugin dans le menu contextuel pour un fichier, dossier ou salle particulier.
• Intégration visionneuse multimédia — intégrez votre plugin directement dans la visionneuse multimédia intégrée.
• Composants UI — utilisez les composants intégrés IconButton et Link pour une apparence cohérente.

Pour en savoir plus sur le Plugin SDK, veuillez visiter api.onlyoffice.com.

Webhooks

Utilisez les webhooks pour effectuer des opérations personnalisées côté application ou site web que vous utilisez, en fonction de différents événements sur ONLYOFFICE DocSpace. Vous pouvez créer et gérer tous vos webhooks, les configurer et parcourir l'historique de chaque webhook pour vérifier leur rendement. Pour en savoir plus sur l'utilisation de webhooks, veuillez consulter ce guide.

Pour en savoir plus sur DocSpace API, veuillez visiter api.onlyoffice.com.

OAuth 2.0

Utilisez OAuth 2.0 pour accéder à l'API d'ONLYOFFICE DocSpace pour l'autorisation et l'accès aux fichiers et d'autres opérations.

Pour créer une nouvelle application,

1. Cliquez sur le bouton Enregistrer une nouvelle application.
2. Remplissez le formulaire :
   • Nom de l'application — le nom de l'application à afficher sur les écrans d'autorisation et dans la liste des applications. Paramètre obligatoire.
   • URL du site web — le lien vers la page d'accueil du site. Paramètre obligatoire.
   • Icône de l'application — l'image à afficher sur les écrans d'autorisation et dans la liste des applications. Paramètre obligatoire.
   • Description — une courte description de l'application.
   • Méthode d'authentification — la méthode de vérification lors de la réception d'un jeton JWT. Pour recevoir un jeton, il faut envoyer une clé SHA. Le cas échéant, cochez la case Autoriser le client public (PKCE).
   • Rediriger les URLs — les liens vers lesquels l'utilisateur est redirigé après l'autorisation réussie de l'application. Saisissez l'adresse et cliquez sur Ajouter. Vous pouvez ajouter plusieurs liens, par exemple vers la version d'essai et la version en production. Paramètre obligatoire.
   • Sources autorisées — les URLs des sources pouvant envoyer des requêtes à l'API de DocSpace sans blocage CORS. Saisissez l'adresse et cliquez sur Ajouter. Vous pouvez ajouter plusieurs liens. Paramètre obligatoire.
   • Étendues d'accès — les autorisations d'une application externe par rapport à l'API de DocSpace. Les étendues permettent de limiter l'accès de votre application aux données des utilisateurs et de définir exactement le type d'accès requis. Cochez la case appropriée Lire ou Écrire à côté de l'option nécessaire : Profil, Contacts, Fichiers et dossiers, Salles, Open ID. L'autorisation à écrire des données active automatiquement la lecture des données. Paramètre obligatoire.
   • URL de la politique de confidentialité — le lien URL vers votre politique de confidentialité qui doit être en conformité avec les lois et les règles appropriées et qui rend claire la collecte, l'utilisation, le partage, la rétention et tout autre traitement de l'information personnelle. Paramètre obligatoire.
   • URL des conditions d'utilisation — le lien URL vers les Conditions d'utilisation auxquelles les utilisateurs doivent se conformer pendant l'utilisation de l'application. Paramètre obligatoire.
3. Cliquez sur le bouton Enregistrer.

La gestion de l'application est réalisée depuis la liste :

• Afficher les informations sur votre application : le nom de l'application, l'auteur, la date de modification, les étendues.
• Désactiver ou activer l'application à l'aide du commutateur État.
• Faites un clic droit et sélectionnez l'option appropriée :
  • Modifier — pour configurer certains paramètres tels que Nom de l'application, Icône de l'application, Description, Méthode d'authentification. Sur cette page, vous pouvez également copier l'ID Client et la Clé secrète client ou réinitialiser la clé secrète le cas échéant.
  • Bouton d'authentification — pour afficher le bouton d'authentification, copier du code HTML, CSS ou JavaScript à incorporer dans votre site web, obtenir un lien d'autorisation ou le vérificateur du code. En cliquant sur le bouton d'authentification, vous pouvez également passer l'ensemble du processus.
  • Info — pour afficher les informations sur l'application, telles que auteur, description, site web, accès, étendues, assistance et les informations légales, la date de dernière modification.
  • Générer un jeton — pour générer le jeton pour développement (pour ne pas répéter le processus chaque fois). La durée de vie des jetons générés est limitée et ils seront annulés lors de la création d'un nouveau jeton.
  • Révoquer le jeton — pour révoquer le jeton généré.
  • Désactiver — pour désactiver l'application et arrêter toutes les sessions actives.
  • Supprimer — pour supprimer l'application et arrêter et supprimer toutes les sessions actives.

Il y a 3 scénarios possibles lorsque vous cliquez sur le lien d'autorisation :

1. Lorsque l'utilisateur n'est pas encore autorisé sur le portail DocSpace, le formulaire d'autorisation s'ouvre. Après une autorisation réussie, l'utilisateur sera redirigé vers l'étape 2 ou 3.
2. Lorsque l'utilisateur a plusieurs portails, il lui sera possible de sélectionner celui qui convient.
3. Lorsque l'utilisateur est déjà autorisé sur le portail DocSpace, il sera redirigé vers la page de consentement, qui affiche les possibilités de l'application, les liens vers la stratégie de sécurité et les conditions d'utilisation. L'utilisateur peut cliquer sur le bouton Autoriser ou Refuser et choisir un autre profil.

Pour en savoir plus sur DocSpace API, veuillez visiter api.onlyoffice.com.

Clés API

Créez et gérez les clés API pour votre ONLYOFFICE DocSpace.

Pour créer une nouvelle clé API,

1. Cliquez sur le bouton Créer une nouvelle clé secrète.
2. Remplissez le formulaire :
   • Nom — saisissez le nom de la clé secrète.
   • Permissions — choisissez l'option appropriée :
     • Tous — activation des autorisations d'accès en lecture et en écriture à toutes les sections.
     • Restreint — activation des autorisations d'accès en lecture ou en écriture à certaines sections. Cochez la case appropriée Lire ou Écrire à côté de l'option nécessaire : Fichiers et dossiers, Salles, Profil, Contacts. L'autorisation à écrire des données active automatiquement la lecture des données.
     • En lecture seule — activation des autorisations d'accès en lecture seule à toutes les sections.
   • Durée de vie des clés — la durée de vie pour désactiver automatiquement la clé secrète à l'expiration de ce délai. La durée de vie commence au moment où la clé est créée.
3. Cliquez sur le bouton Générer.
4. Dans la nouvelle fenêtre, copiez la clé générée et cliquez sur Terminé.

La gestion des clés API est réalisée depuis la liste :

• Afficher les informations sur votre clé : Nom, Clé secrète, Créé, Dernière utilisation, Créé par, Permissions.
• Désactiver ou activer la clé à l'aide du commutateur État.
• Faites un clic droit et sélectionnez l'option appropriée :
  • Modifier — pour modifier le Nom et les Permissions de la clé.
  • Supprimer — pour supprimer la clé.

Pour en savoir plus sur DocSpace API, veuillez visiter api.onlyoffice.com.