Zum Hauptinhalt springen
PDF4me APIIntegrationenWissensdatenbankErweiterungenAPI-TesterBlog

Text hervorheben

PDF → Text hervorheben

Dieser Endpunkt entspricht dem Highlight Postman-Kollektion: POST /api/v2/HighlightText mit Körper document, docContent, Und textHighlightingAction (gleiche Schlüssel und Verschachtelung wie bei Postmans Rohdaten) JSON).

Probieren Sie die Highlight Text API aus.​

:::Hinweis Kurzübersicht

Kurzübersicht Weg: POST /api/v2/HighlightText (Postbote: https://api.pdf4me.com/api/v2/HighlightText) · Tasten des Körpers: document, docContent, textHighlightingAction · Überschriften: Content-Type: application/json, Authorization: Basic <api-key> :::

Live ausprobieren
  1. dokumentieren: JSON Objekt mit Name (Hauptstadt Nz.B. { "Name": "Thiscar.pdf" }Verlassen Sie das Feld leer (Gesamten Text löschen) wenn Sie nicht möchten document Eigentum überhaupt.
  2. docContent: PDF als Base64 (Datei hochladen). Darf nicht leer sein, damit die Datei ausgeführt werden kann (genau wie bei Postman).
  3. textHighlightingAction: JSON Objekt mit TextHighlightList: ein Array von { "Text": "…", "HighlightColor": "#RRGGBB" }.
Loading API Tester...

Gleiche Struktur wie Postman (Rohdaten)​

Ihre exportierte Sammlung verwendet genau diese Eigenschaften der obersten Ebene:

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

Es gibt NEIN docName, async, oder IsAsync In dieser Sammlung sind nur die drei oben genannten Schlüssel sowie die Authentifizierungs-Header enthalten.

Wenn Sie sehen 400: "Invalid File"​

Diese Antwort stammt von der API wenn die Dateibytes werden nicht akzeptiert (nicht wenn JSON (die Tasten sind falsch). Typische Ursachen:

  1. Kein echtes PDFDie Aktion erwartet eine PDFBitte senden Sie keine Word-Dokumente, Bilder oder leere Inhalte. Siehe Datei ist leer / ungültige DateiDie
  2. document.Name vs Datei: Verwenden document.Name mit dem gleicher Basisdateiname als die PDF Sie haben kodiert (einschließlich .pdfz. B. wenn Sie hochladen invoice.pdf, verwenden { "Name": "invoice.pdf" }Eine Diskrepanz kann in manchen Umgebungen zu Validierungsfehlern führen.
  3. Base64 von anderer Stelle kopiert: Entfernen Zeilenumbrüche im Base64 Zeichenkette und schließen Sie kein ein data:application/pdf;base64, Präfix im Feld (der Tester entfernt beides beim Senden, aber ein fehlerhafter oder abgeschnittener Text schlägt trotzdem fehl).
  4. Hochladen statt Einfügen: Verwenden Datei hochladen An docContent Die Kodierung ist also ein einziger kontinuierlicher Vorgang. Base64 Zeichenkette.

Weitere 400 Ursachen​

  • JSONKeine nachfolgenden Kommas; textHighlightingAction muss ein nicht leeres enthalten TextHighlightListDie
  • UmfeldPostman kann verwenden api.pdf4me.comDer Dokumententester kann verwenden api-dev.pdf4me.com oder ein Stellvertreter, der JSON Die Karosserie sollte noch zusammenpassen.

Überblick, Parameter und Anwendungsfälle​

Feld → JSON-Zuordnung​

Jeder Körperparametername ist der JSON Schlüssel: document, docContent, textHighlightingAction, das Gleiche wie Suchen und Ersetzen Stiltester.

Postbotenparität​

Import Highlight.postman_collection und vergleichen Sie die roh Körper mit dem cURL In der Vorschau im Tester sollten sie übereinstimmen, nachdem Sie dasselbe hochgeladen haben. PDFDie

Voraussetzungen​

Antwortformat​

Typischerweise ein hervorgehobener PDF (binär oder JSON mit docContent).

Hilfe erhalten​

Get Your API KeyAPI DocumentationAPI Tester Home