Passa al contenuto principale
PDF4me APIIntegrazioniBase di conoscenzaEstensioniTester APIBlog

Testo evidenziato

PDF → Testo evidenziato

Questo endpoint corrisponde a Evidenziare Collezione del postino: POST /api/v2/HighlightText con corpo document, docContent, E textHighlightingAction (stesse chiavi e annidamento del codice grezzo di Postman) JSON).

Prova l'API Highlight Text​

:::nota - Guida rapida Sentiero: POST /api/v2/HighlightText (Postino: https://api.pdf4me.com/api/v2/HighlightText) · Legenda del corpo: document, docContent, textHighlightingAction · Intestazioni: Content-Type: application/json, Authorization: Basic <api-key> :::

Provalo dal vivo
  1. documento: JSON oggetto con Name (capital N), per esempio. { "Name": "Thiscar.pdf" }Lascia il campo vuoto (elimina tutto il testo) se non vuoi un document proprietà in generale.
  2. docContent: PDF COME Base64 (carica un file). Deve essere non vuoto per un'esecuzione effettiva (come Postman).
  3. azione di evidenziazione del testo: JSON oggetto con TextHighlightList: una serie di { "Text": "…", "HighlightColor": "#RRGGBB" }.
Loading API Tester...

Stessa struttura del Postino (corpo grezzo)​

La raccolta esportata utilizza esattamente queste proprietà di primo livello:

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

C'è NO docName, async, O IsAsync in quella raccolta, solo le tre chiavi sopra menzionate più le intestazioni di autenticazione.

Se vedi 400: "Invalid File"​

Questa risposta proviene da API quando il I byte dei file non sono accettati (non quando JSON (i tasti sono sbagliati). Cause tipiche:

  1. Non è un vero PDF: L'azione prevede un PDFNon inviare documenti Word, immagini o contenuti vuoti. Vedi Il file è vuoto / File non valido.
  2. document.Name vs file: Utilizzo document.Name con il stesso nome di file di base come il PDF hai codificato (incluso .pdf), ad esempio se carichi invoice.pdf, utilizzo { "Name": "invoice.pdf" }Una discrepanza può contribuire a errori di convalida in alcuni ambienti.
  3. Base64 incollato da altrove: Rimuovere interruzioni di riga nel Base64 stringa e non includere una data:application/pdf;base64, prefisso nel campo (il tester rimuove entrambi durante l'invio, ma un testo incollato corrotto o troncato non viene comunque accettato).
  4. Carica invece di incollare: Utilizzo Carica file SU docContent quindi la codifica è un singolo continuo Base64 corda.

Altre 400 cause​

  • JSON: Nessuna virgola finale; azione di evidenziazione del testo deve includere un non vuoto Elenco di testo evidenziato.
  • Ambiente: Il postino può usare api.pdf4me.com; il tester della documentazione può utilizzare api-dev.pdf4me.com o un delegato, il JSON La carrozzeria dovrebbe comunque corrispondere.

Panoramica, parametri e casi d'uso​

Mappatura campo → JSON​

Il nome di ciascun parametro del corpo è il JSON chiave: document, docContent, textHighlightingAction, uguale a Trova e sostituisci tester di stile.

Postmanparità​

Scala Highlight.postman_collection e confrontare il crudo corpo con il cURL anteprima nel tester, dovrebbero corrispondere dopo aver caricato lo stesso PDF.

Prerequisiti​

Formato di risposta​

In genere un evidenziato PDF (binario o JSON con docContent).

Richiedi assistenza​

Get Your API KeyAPI DocumentationAPI Tester Home