Mise à jour des annotations des hyperliens
PDF4me → Mise à jour des annotations des hyperliens
Le Mise à jour des annotations des hyperliens API met à jour le texte des liens hypertextes et URLs dans un PDFVous envoyez le PDF (docContent Base64, Nom du document), liste d'annotations de mise à jour des liens hypertextes (tableau d'objets de mise à jour de lien hypertexte avec SearchOn, SearchValue, IsExpression, TextCurrentValue, TextNewValue, URLCurrentValue, URLNewValue), et éventuellement asynchrone. Le API renvoie le PDF avec des liens hypertextes mis à jour. Utilisez l'outil de test ci-dessous pour l'essayer ; vous trouverez plus de détails dans les sections suivantes.
Essayez l'annotation « Mettre à jour les hyperliens » API
Point final : POST /api/v2/UpdateHyperlinkAnnotation · Requis: clé API, contenu du document, nom du document, mise à jour de la liste des annotations de liens hypertextes
Utilisez le formulaire ci-dessous pour envoyer votre API clé, PDF (Base64), et un tableau d'objets de mise à jour de lien hypertexte. La réponse est le PDF avec des hyperliens mis à jour. Aucun code requis, remplissez les champs et cliquez Envoyer une requête.
Aperçu, paramètres et cas d'utilisation
- Overview
- Parameters
- Use cases
Qu'est-ce que l'annotation « Mettre à jour les hyperliens » ?
Ce point de terminaison met à jour les hyperliens existants dans un PDF en modifiant le texte affiché et/ou le URL destination. Vous fournissez la destination. PDF (Base64) et liste d'annotations de mise à jour des liens hypertextes (tableau d'objets de mise à jour de lien hypertexte). Chaque objet spécifie les critères de recherche (SearchOn, SearchValue, IsExpression), le texte actuel/URL trouver, et nouveau texte/URL (TextCurrentValue, TextNewValue, URLCurrentValue, URLNewValue). Le API renvoie le PDF avec des hyperliens correspondants mis à jour.
structure de l'objet de mise à jour du lien hypertexte
Chaque objet dans liste d'annotations de mise à jour des liens hypertextes devrait contenir :
- SearchOn: Type de critères de recherche (ex. : Texte)
- SearchValue: Valeur à rechercher
- IsExpression: Utiliser ou non la correspondance d'expressions
- TextCurrentValue: Texte hyperlié actuel à remplacer
- TextNewValueNouveau texte d'affichage pour le lien hypertexte
- URLCurrentValue: Actuel URL destination à remplacer
- URLNewValue: Nouveau URL destination
À utiliser lorsque vous devez corriger ou mettre à jour en masse des hyperliens dans un PDF (par exemple, changer les anciens URLs (aux nouveaux). Pour l'intégration webhook, utilisez Obtenir le document à partir de PDF4me.
API paramètres
| Paramètre | Taper | Requis | Description |
|---|---|---|---|
| clé API | chaîne | Oui | Ton PDF4me API clé, Base64 encodé. Récupérez-le depuis le tableau de bord. |
| docContent | base64 | Oui | PDF contenu du fichier (Base64) contenant des hyperliens. |
| Nom du document | chaîne | Oui | Sortir PDF nom du fichier (par exemple, output.pdf). |
| liste d'annotations de mise à jour des liens hypertextes | tableau | Oui | Array des objets de mise à jour de lien hypertexte (SearchOn, SearchValue, IsExpression, TextCurrentValue, TextNewValue, URLCurrentValue, URLNewValue). |
| asynchrone | booléen | Non | Activer le traitement asynchrone. |
Quand utiliser l'annotation « Mettre à jour les hyperliens »
- En gros URL mises à jour: Changer l'ancien URLs à de nouveaux éléments via de nombreux hyperliens (par exemple, changement de domaine, redirections).
- Afficher le texteMettez à jour le texte visible du lien hypertexte tout en conservant ou en modifiant le URL.
- Liens brisés: Corriger les liens brisés ou obsolètes dans PDFs avant distribution.
- Liens vers le modèleMettre à jour l'espace réservé ou le modèle URLs dans généré PDFs.
Pour les schémas de requête/réponse et des exemples de code, voir Mise à jour des annotations des hyperliens dans le PDF4me API documents.
Prérequis
Avant d'utiliser ce point de terminaison, assurez-vous d'avoir :
- Un valide PDF4me API clé (Obtenez votre API Clé)
- UN PDF fichier dans Base64 format contenant des hyperliens
Format de réponse
Le API renvoie un PDF fichier contenant des hyperliens mis à jour.