Saltar al contenido principal
PDF4me APIIntegracionesBase de conocimientosExtensionesProbador de APIBlog

Resaltar texto

PDF → Resaltar texto

Este punto final coincide con el Destacar Colección del cartero: POST /api/v2/HighlightText con cuerpo document, docContent, y textHighlightingAction (mismas claves y anidamiento que el archivo sin procesar de Postman JSON).

Pruebe la API de resaltado de texto.​

:::nota Referencia rápida Camino: POST /api/v2/HighlightText (Cartero: https://api.pdf4me.com/api/v2/HighlightText) · Claves del cuerpo: document, docContent, textHighlightingAction · Encabezados: Content-Type: application/json, Authorization: Basic <api-key> :::

Pruébalo en vivo
  1. documento: JSON objeto con Name (capital norte), p.ej. { "Name": "Thiscar.pdf" }Abandona el campo. vacío (eliminar todo el texto) si no desea un document propiedad en absoluto.
  2. docContent: PDF como Base64 (Subir un archivo). Debe contener datos para que funcione correctamente (igual que en Postman).
  3. Acción de resaltado de texto: JSON objeto con TextHighlightList: una matriz de { "Text": "…", "HighlightColor": "#RRGGBB" }.
Loading API Tester...

Misma estructura que Postman (cuerpo en bruto)​

La colección exportada utiliza exactamente estas propiedades de nivel superior:

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

Hay No docName, async, o IsAsync En esa colección, solo las tres claves anteriores más los encabezados de autenticación.

Si ves 400: "Invalid File"​

Esa respuesta proviene de la API cuando el Los bytes del archivo no son aceptados (no cuando JSON Las claves son incorrectas). Causas típicas:

  1. No es un PDF real: La acción espera una PDFNo envíe documentos de Word, imágenes ni contenido vacío. Consulte El archivo está vacío / Archivo no válido.
  2. document.Name archivo vs: Usar document.Name con el mismo nombre de archivo base como el PDF usted codificó (incluyendo .pdf), por ejemplo, si usted sube invoice.pdf, usar { "Name": "invoice.pdf" }Una discrepancia puede contribuir a fallos de validación en algunos entornos.
  3. Base64 pegado de otro sitio: Eliminar saltos de línea en el Base64 cadena y no incluye una data:application/pdf;base64, prefijo en el campo (el probador elimina ambos al enviar, pero un pegado corrupto o truncado sigue fallando).
  4. Sube el archivo en lugar de pegarlo.: Usar Subir archivo en docContent por lo que la codificación es una única y continua Base64 cadena.

Otras 400 causas​

  • JSON: Sin comas al final; Acción de resaltado de texto debe incluir un no vacío Lista resaltada de texto.
  • Ambiente: El cartero puede usar api.pdf4me.com; el probador de documentos puede usar api-dev.pdf4me.com o un representante, el JSON El cuerpo aún debe coincidir.

Descripción general, parámetros y casos de uso​

Mapeo de campos a JSON​

Cada nombre de parámetro del cuerpo es el JSON llave: document, docContent, textHighlightingAction, igual que Buscar y reemplazar probadores de estilo.

paridad del cartero​

Importar Highlight.postman_collection y comparar el crudo cuerpo con el cURL Vista previa en el probador, deberían coincidir después de que cargues el mismo PDF.

Requisitos previos​

Formato de respuesta​

Normalmente un resaltado PDF (binario o JSON con docContent).

Obtén ayuda​

Get Your API KeyAPI DocumentationAPI Tester Home