Aller au contenu principal
API PDF4meIntégrationsBase de connaissancesExtensionsTesteur d'APIBlog

Surligner le texte

PDF → Surligner le texte

Ce point de terminaison correspond au Souligner Collection du facteur : POST /api/v2/HighlightText avec corps document, docContent, et textHighlightingAction (mêmes touches et imbrication que le texte brut de Postman) JSON).

Essayez l'API Highlight Text​

Référence rapide

Chemin: POST /api/v2/HighlightText (Facteur : https://api.pdf4me.com/api/v2/HighlightText) · Clés du corps : document, docContent, textHighlightingAction · En-têtes : Content-Type: application/json, Authorization: Basic <api-key>

Essayez-le en direct
  1. document: JSON objet avec Name (capital N), par exemple { "Name": "Thiscar.pdf" }Quittez le terrain vide (supprimez tout le texte) si vous ne voulez pas de document propriété du tout.
  2. docContent: PDF comme Base64 (Téléverser un fichier). Ce champ doit contenir des éléments non vides pour que l'exécution soit effective (comme avec Postman).
  3. Action de surbrillance du texte: JSON objet avec TextHighlightList: un tableau de { "Text": "…", "HighlightColor": "#RRGGBB" }.
Loading API Tester...

Même structure que Postman (corps brut)​

Votre collection exportée utilise exactement ces propriétés de niveau supérieur :

{
 "document": {
 "Name": "Thiscar.pdf"
 },
 "docContent": "<base64: from Postman or from file upload here>",
 "textHighlightingAction": {
 "TextHighlightList": [
 { "Text": "Welcome", "HighlightColor": "#FF2C00" },
 { "Text": "promise", "HighlightColor": "#00FF00" }
 ]
 }
}

Il y a Non docName, async, ou IsAsync Dans cette collection, seules les trois clés ci-dessus, plus les en-têtes d'authentification, sont incluses.

Si vous voyez 400: "Invalid File"​

Cette réponse provient de API quand le Les octets de fichier ne sont pas acceptés (pas quand) JSON (Les clés sont incorrectes). Causes typiques :

  1. Ce n'est pas un vrai PDF.L'action attend un PDFN’envoyez pas de fichiers Word, d’images ou de contenu vide. Voir Fichier vide / fichier invalide.
  2. document.Name fichier vs: Utiliser document.Name avec le même nom de fichier de base comme le PDF vous avez encodé (y compris .pdf), par exemple si vous téléchargez invoice.pdf, utiliser { "Name": "invoice.pdf" }Une incohérence peut contribuer à des échecs de validation dans certains environnements.
  3. Base64 collé d'ailleurs: Retirer sauts de ligne dans le Base64 chaîne et n'incluez pas de data:application/pdf;base64, préfixe dans le champ (le testeur supprime les deux lors de l'envoi, mais un collage corrompu ou tronqué échoue toujours).
  4. Téléversez au lieu de coller: Utiliser Téléverser un fichier sur docContent L'encodage est donc une seule et continue Base64 chaîne.

400 autres causes​

  • JSON: Pas de virgules finales ; Action de surbrillance du texte doit inclure un élément non vide Liste de surbrillance de texte.
  • EnvironnementLe facteur peut utiliser api.pdf4me.com; le testeur de documentation peut utiliser api-dev.pdf4me.com ou par procuration, le JSON Le corps doit toujours correspondre.

Aperçu, paramètres et cas d'utilisation​

Champ → Correspondance JSON​

Chaque nom de paramètre du corps est le JSON clé: document, docContent, textHighlightingAction, pareil que Rechercher et remplacer testeurs de style.

parité des facteurs​

Importer Highlight.postman_collection et comparer les brut le corps avec le cURL Dans l'outil de test, l'aperçu devrait correspondre après le téléchargement du même fichier. PDF.

Prérequis​

Format de réponse​

Généralement, un élément mis en évidence PDF (binaire ou JSON avec docContent).

Obtenez de l'aide​

Get Your API KeyAPI DocumentationAPI Tester Home