ONLYOFFICE Docs 8.2 pour les développeurs : mises à jour de l’API

En plus des nouvelles fonctionnalités de la version 8.2, nous avons mis à jour l’API pour les éditeurs, l’API Office et les plugins, ajouté le Framework Java pour Document Builder ainsi que le SDK d’intégration PHP. Consultez tous les détails ci-dessous.

Déploiement sans temps d’arrêt

Le déploiement sans temps d’arrêt est un excellent moyen de mettre à jour une application sans nécessiter de pause. Ainsi, il est possible de mettre à jour les éditeurs sans avoir à les mettre hors ligne.

Comment cela fonctionne-t-il ? L’instance de ONLYOFFICE Docs (Document Server, DS) avec la nouvelle version est lancée en parallèle au Document Server en cours d’exécution. De nouvelles sessions d’édition sont ouvertes dans le nouveau DS. La version précédente du DS fonctionne jusqu’à ce que les utilisateurs terminent eux-mêmes leurs sessions d’édition. Ce n’est qu’après cela que l’ancien DS s’arrête.

En ce qui concerne les Shards de ONLYOFFICE Docs, nous sommes en mesure de diriger une session d’édition vers le DS spécifique dans le cluster. Il est donc possible de faire travailler en parallèle des serveurs de documents de versions différentes. N’oubliez pas de tenir compte du fait que la duplication des ressources et le processus de mise à jour lui-même peuvent prendre un certain temps.

Remarque : le déploiement en temps zéro est disponible pour ONLYOFFICE Docs livré sous forme de Shards Kubernetes. Vous souhaitez en savoir plus ? Contactez-nous via sales@onlyoffice.com.

SDK d’intégration PHP

Intégrez facilement ONLYOFFICE Docs dans votre application écrite en PHP. Le SDK comprend le code général pour les intégrations PHP, la création de la configuration d’initialisation et la gestion des méthodes communes sur le backend. Consulter le SDK

Le SDK PHP est maintenant implémenté, par exemple, dans l’intégration d’ONLYOFFICE et de Chamilo.

Nouveaux styles d’interface

Le paramètre editorConfig.customization.features apporte deux champs supplémentaires – tabStyle et tabBackground. De cette façon, vous pouvez ajuster l’apparence de l’éditeur à votre convenance.

Le premier permet de définir le style de remplissage (les onglets de la barre d’outils supérieure sont affichés distinctement) ou de ligne (les onglets de la barre d’outils supérieure sont mis en évidence par un soulignement).

Ce dernier définit si l’arrière-plan des onglets de la barre d’outils supérieure correspond à l’arrière-plan de l’en-tête ou à l’arrière-plan de la barre d’outils.

En outre, nous avons ajouté le champ imageLight au paramètre editorConfig.customization.logo. Il définit le chemin d’accès au fichier image utilisé pour l’en-tête clair, par exemple, dans le thème gris nouvellement ajouté.

const logo = {
  image: "https://example.com/logo.png",
  imageDark: "https://example.com/dark-logo.png",
  imageLight: "https://example.com/light-logo.png",
  url: "https://example.com",
  visible: true,
}

Insertion de textes provenant de sources tierces

Le type de sélection de document insert-text est ajouté au paramètre c de la méthode setRequestedDocument. Ainsi, les utilisateurs peuvent sélectionner un document dans le fichier local/URL/stockage pour insérer son contenu dans le document actuel.

docEditor.setRequestedDocument({
  c: "insert-text",
  fileType: "docx",
  url: "https://example.com/url-to-example-document.docx",
...

Vérification de l’état du document

Le paramètre users est désormais ajouté à la réponse de la commande info. Ce paramètre définit la liste des identifiants des utilisateurs qui ont ouvert le document à l’édition. Lorsque le document a été modifié, le paramètre users renvoie l’identifiant de l’utilisateur qui a été le dernier à modifier le document.

{
  "error": 0,
  "key": "Khirz6zTPdfd7",
  "users": ["6d5a81d0", "78e1e841"]
}

Autres changements apportés à l’API de Docs

• Nouveaux paramètres de demande pour l’API de conversion WOPI pour travailler avec des documents protégés : Password et PasswordToOpen.
• L’adresse https://documentserver/coauthoring/CommandService.ashx du service de commande est remplacée par https://documentserver/coauthoring/command.
• Le champ editorConfig.location est obsolète. Veuillez utiliser le champ editorConfig.region à la place pour définir les unités de mesure par défaut dans tous les types d’éditeurs.
• Le champ editorConfig.customization.toolbarNoTabs est obsolète, veuillez utiliser les champs editorConfig.customization.features.tabStyle et editorConfig.customization.features.tabBackground à la place.

Obtenez la dernière version de ONLYOFFICE Docs Developer :

TÉLÉCHARGER MAINTENANT

Notifications par e-mail : avertissements concernant les licences et les limites de quotas

Il est désormais possible d’envoyer des notifications par e-mail, par exemple lorsque la licence est sur le point d’expirer ou que la limite de connexion est sur le point d’être atteinte.

Comment cela fonctionne-t-il ? Nous avons ajouté la possibilité de définir les paramètres du serveur de messagerie dans la configuration du serveur. Un serveur de messagerie externe est utilisé pour envoyer des notifications. La connexion à ce serveur se fait par l’intermédiaire de la bibliothèque Nodemailer. De nombreux paramètres de la configuration du serveur sont transférés directement dans cette bibliothèque.

Améliorations de l’API pour les plugins

L’API du plugin apporte également des améliorations utiles, notamment des méthodes permettant d’effectuer des actions Redo et Undo.

• api.prototype.Undo = function()
• api.prototype.Redo = function()
• api.prototype.CanUndo = function()
• api.prototype.CanRedo = function()

Consultez la liste complète des mises à jour de l’API du plugin.

Cadre Java pour Document Builder

Pour ONLYOFFICE Document Builder, un Java Builder Framework est désormais disponible. Il contient une collection de bibliothèques, de classes et de fonctions qui facilitent grandement le développement rapide d’applications en Java dotées de capacités de création de documents.

OBTENIR DOCUMENT BUILDER

API Office

Pour l’API Office JavaScript, nous avons ajouté beaucoup de nouvelles méthodes pour la version 8.2, y compris celles pour :

• plages ;
• tableaux croisés dynamiques ;
• espaces réservés ;
• extraction et remplacement de mots/phrases ;
• mise à jour de tous les champs ;
• contours ;
• et autres.

Consultez la liste complète des nouvelles méthodes.