En tant que développeur Python, vous pouvez annoter n’importe quel fichier Word (.doc ou .docx) par programmation sur le cloud. Les annotations sont généralement des métadonnées sous la forme de commentaires, de notes, d’explications ou d’autres types de remarques externes dans le document fournissant des informations supplémentaires sur une donnée existante. Cet article se concentrera sur la façon d’annoter des fichiers DOCX à l’aide d’une API REST en Python.

Les sujets suivants seront traités dans cet article :

API REST d’annotation de documents et SDK Python

GroupDocs. Annotation Cloud

Pour annoter des documents DOC ou DOCX, j’utiliserai l’API Python SDK of GroupDocs.Annotation Cloud. Il vous permet de créer par programmation des outils d’annotation de documents et d’images en ligne. Ces outils peuvent être utilisés pour ajouter des annotations, des superpositions de filigranes, des remplacements de texte, des caviardages, des notes autocollantes et des annotations de texte aux documents commerciaux de tous les formats courants. Il fournit également les SDK .NET, Java, PHP, Ruby et Node.js en tant que membres de la famille d’annotations de documents pour l’API Cloud.

Vous pouvez installer GroupDocs.Annotation Cloud dans votre projet Python à l’aide de la commande suivante dans la console :

pip install groupdocs_annotation_cloud

Veuillez obtenir votre ID client et votre secret client à partir du tableau de bord avant de commencer à suivre les étapes et les exemples de code disponibles. Ajoutez votre identifiant et votre secret dans le code comme illustré ci-dessous :

client_id = "112f0f38-9dae-42d5-b4fc-cc84ae644972"
client_secret = "16ad3fe0bdc39c910f57d2fd48a5d618"
my_storage = ""

configurations = groupdocs_annotation_cloud.Configuration(client_id, client_secret)
configurations.api_base_url = "https://api.groupdocs.cloud"

Annoter des fichiers DOCX à l’aide d’une API REST en Python

Vous pouvez ajouter des annotations au fichier DOCX en suivant les étapes simples mentionnées ci-dessous :

Télécharger le document

Tout d’abord, téléchargez le fichier DOCX sur le Cloud en utilisant l’exemple de code ci-dessous :

# Créer une instance de l'API
file_api = groupdocs_annotation_cloud.FileApi.from_config(configurations)

request = groupdocs_annotation_cloud.UploadFileRequest("one-page.docx", "C:\\Files\\one-page.docx", my_storage)
response = file_api.upload_file(request)

Par conséquent, le fichier DOCX téléchargé sera disponible dans la section fichiers de votre tableau de bord sur le cloud.

Ajouter des annotations aux fichiers DOCX en Python

Veuillez suivre les étapes mentionnées ci-dessous pour insérer des annotations dans le document Word par programmation.

  • Créer une instance d’AnnotationInfo
  • Définissez diverses propriétés d’annotation, par exemple la position, le type, le texte, etc.
  • Créer une instance FileInfo
  • Définir le chemin du fichier
  • Créer une instance d’AnnotateOptions
  • Définir les informations de fichier sur AnnotateOptions
  • Définir l’annotation sur AnnotateOptions
  • Créer une requête en appelant la méthode AnnotateRequest
  • Obtenez des résultats en appelant la méthode AnnotateApi.annotate()

L’extrait de code suivant montre comment insérer des annotations de zone dans le document Word à l’aide d’une API REST.

api = groupdocs_annotation_cloud.AnnotateApi.from_keys(client_id, client_secret)

a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 100
a1.box.y = 100
a1.box.width = 200
a1.box.height = 100
a1.page_number = 0
a1.pen_color = 1201033
a1.pen_style = "Solid"
a1.pen_width = 1
a1.opacity = 0.7

# Ajouter une annotation de zone
a1.type = "Area"
a1.text = "This is area annotation"
a1.creator_name = "Anonym A."

file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "one-page.docx"
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "Output\\output.docx"

request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)

En conséquence, les annotations de zone seront insérées dans le document comme indiqué ci-dessous.

Ajouter des annotations aux fichiers DOCX en Python

Types d’annotations pris en charge

Veuillez trouver ci-dessous la liste des types d’annotations pris en charge, que vous pouvez ajouter à vos fichiers DOCX en suivant les étapes mentionnées précédemment :

  • Zone
  • Distance
  • Lien
  • Indiquer
  • Polyligne
  • Image
  • Texte
  • Filigrane
  • Flèche

Télécharger le fichier mis à jour

L’exemple de code ci-dessus enregistrera le fichier DOCX annoté sur le cloud. Vous pouvez le télécharger à l’aide de l’exemple de code suivant :

# Créer une instance de l'API
file_api = groupdocs_annotation_cloud.FileApi.from_config(configurations)

request = groupdocs_annotation_cloud.DownloadFileRequest("Output\\output.docx", my_storage)
response = file_api.download_file(request)

# Déplacez le fichier téléchargé dans votre répertoire de travail
shutil.move(response, "C:\\Files\\")

Ajouter plusieurs annotations à l’aide de Python

Veuillez suivre les étapes mentionnées ci-dessous pour ajouter plusieurs annotations à vos fichiers DOCX par programmation.

  • Créer la première instance d’AnnotationInfo
  • Définissez diverses propriétés d’annotation pour la première instance, par exemple la position, le type, le texte, etc.
  • Créer une deuxième instance AnnotationInfo
  • Définissez diverses propriétés d’annotation pour la deuxième instance, par exemple la position, le type, le texte, etc.
  • Créer une instance FileInfo
  • Définir le chemin du fichier
  • Créer une instance d’AnnotateOptions
  • Définir les informations de fichier sur AnnotateOptions
  • Définissez les première et deuxième annotations sur AnnotateOptions
  • Créer une requête en appelant la méthode AnnotateRequest
  • Obtenez des résultats en appelant la méthode AnnotateApi.annotate()

L’extrait de code suivant montre comment ajouter plusieurs annotations au fichier DOCX à l’aide d’une API REST. Veuillez suivre les étapes mentionnées précédemment pour charger et télécharger un fichier.

api = groupdocs_annotation_cloud.AnnotateApi.from_keys(client_id, client_secret)
  
a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 200
a1.box.y = 200
a1.box.width = 300
a1.box.height = 100
a1.page_number = 0
a1.pen_color = 1201033
a1.pen_style = "Solid"
a1.pen_width = 1
a1.opacity = 0.2
a1.type = "Watermark"
a1.text = "This is watermark annotation"
a1.creator_name = "Anonym A."
    
a2 = groupdocs_annotation_cloud.AnnotationInfo()
a2.annotation_position = groupdocs_annotation_cloud.Point()
a2.annotation_position.x = 852
a2.annotation_position.y = 59.38
a2.box = groupdocs_annotation_cloud.Rectangle()
a2.box.x = 375.8
a2.box.y = 59.38
a2.box.width = 88
a2.box.height = 37
a2.page_number = 2
a2.pen_color = 1201033
a2.pen_style = "Solid"
a2.pen_width = 1
a2.opacity = 0.9
a2.type = "Image"
a2.text = "This is Image annotation"
a2.creator_name = "Anonym A."
a2.image_path = "JohnSmith.png"
    
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "ten-pages.docx"
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1, a2]
options.output_path = "Output\\output.docx"

request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)

En conséquence, les annotations d’image et de filigrane seront insérées dans le document comme indiqué ci-dessous.

annotations d'image et de filigrane

Conclusion

Dans cet article, vous avez appris à ajouter différents types d’annotations aux documents Word sur le cloud avec l’API REST Document Annotation à l’aide de Python. Vous avez également appris à télécharger par programmation le fichier DOCX sur le cloud, puis à télécharger le fichier annoté à partir du cloud. Vous pouvez en savoir plus sur l’API GroupDocs.Annotation Cloud à l’aide de la documentation. Nous fournissons également une section API Reference qui vous permet de visualiser et d’interagir avec nos API directement via le navigateur. En cas d’ambiguïté, n’hésitez pas à nous contacter sur le forum.