Actualizar la anotación de hipervínculos
PDF4me → Actualizar la anotación de hipervínculos
El Actualizar la anotación de hipervínculos API actualiza el texto del hipervínculo y URLs en un PDF. Tú envías el PDF (docContent Base64, Nombre del documento), actualizar la lista de anotaciones de hipervínculos (matriz de objetos de actualización de hipervínculos con SearchOn, SearchValue, IsExpression, TextCurrentValue, TextNewValue, URLCurrentValue, URLNewValue) y opcionalmente asíncrono. El API devuelve el PDF Con enlaces actualizados. Utilice la herramienta de prueba que aparece a continuación para comprobarlo; encontrará más detalles en las secciones siguientes.
Pruebe la anotación Actualizar hipervínculos API
:::nota Referencia rápida
Punto final: POST /api/v2/UpdateHyperlinkAnnotation · Requerido: clave-api, contenido-documento, nombre-documento, actualizar-lista-de-anotaciones-hipervínculos
:::
Utiliza el formulario a continuación para enviar tu solicitud API llave, PDF (Base64), y una matriz de objetos de actualización de hipervínculos. La respuesta es la PDF con hipervínculos actualizados. No se requiere código, complete los campos y haga clic. Enviar solicitud.
Descripción general, parámetros y casos de uso
- Overview
- Parameters
- Use cases
¿Qué es la anotación de actualización de hipervínculos?
Este punto final actualiza los hipervínculos existentes en un PDF cambiando el texto que se muestra y/o el URL destino. Usted proporciona el PDF (Base64) y actualizar la lista de anotaciones de hipervínculos (matriz de objetos de actualización de hipervínculos). Cada objeto especifica los criterios de búsqueda (SearchOn, SearchValue, IsExpression), el texto actual/URL para encontrar y nuevo texto/URL (ValorActualDeTexto, NuevoValorDeTexto, ValorActualDeURL, NuevoValorDeURL). El API devuelve el PDF con los hipervínculos correspondientes actualizados.
Estructura de objetos de actualización de hipervínculos
Cada objeto en actualizar la lista de anotaciones de hipervínculos debe contener:
- SearchOn: Tipo de criterio de búsqueda (p. ej., Texto)
- SearchValue: Valor a buscar
- IsExpression: Si se debe usar la coincidencia de expresiones
- TextCurrentValue: Texto hipervinculado actual a reemplazar
- TextNewValueNuevo texto para mostrar en el hipervínculo
- URLCurrentValue: Actual URL destino para reemplazar
- URLNewValue: Nuevo URL destino
Usar cuando necesites corregir o actualizar masivamente hipervínculos en un PDF (p. ej., cambiar antiguo URLs a los nuevos). Para la integración de webhook utilice Obtener documento de PDF4me.
API parámetros
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| clave API | cadena | Sí | Su PDF4me API llave, Base64 codificado. Consíguelo desde el panel. |
| docContent | base64 | Sí | PDF contenido del archivo (Base64) que contienen hipervínculos. |
| Nombre del documento | cadena | Sí | Producción PDF nombre del archivo (por ejemplo, output.pdf). |
| actualizar la lista de anotaciones de hipervínculos | formación | Sí | Array de objetos de actualización de hipervínculos (SearchOn, SearchValue, IsExpression, TextCurrentValue, TextNewValue, URLCurrentValue, URLNewValue). |
| asíncrono | booleano | No | Habilitar el procesamiento asíncrono. |
Cuándo usar la anotación Actualizar hipervínculos
- A granel URL actualizaciones: Cambiar antiguo URLs a nuevos enlaces a través de múltiples hipervínculos (por ejemplo, cambio de dominio, redirecciones).
- Mostrar texto: Actualizar el texto del hipervínculo visible manteniendo o cambiando el URL.
- Enlaces rotos: Reparar enlaces rotos o desactualizados en PDFs antes de la distribución.
- Enlaces de plantilla: Actualizar marcador de posición o plantilla URLs en generado PDFs.
Para ver esquemas de solicitud/respuesta y ejemplos de código, consulte Actualizar la anotación de hipervínculos en el PDF4me API documentos.
Requisitos previos
Antes de utilizar este punto final, asegúrese de tener:
- Un válido PDF4me API llave (Consigue tu API Llave)
- A PDF archivo en Base64 formato que contiene hipervínculos
Formato de respuesta
El API devuelve un PDF Archivo con hipervínculos actualizados.