1. IronSecureDoc
  2. Tutoriels
  3. API REST pour IronSecureDoc

API REST pour IronSecureDoc en C

Curtis Chau
Curtis Chau
Mis à jour:
This article was translated from English: Does it need improvement?
Translated
View the article in English

Voici la documentation de référence de l'API REST pour votre instance d'IronSecureDoc. Ce tutoriel suppose que vous avez déjà une instance de conteneur en cours d'exécution. Si vous souhaitez commencer, veuillez suivre notre guide.

Accéder aux fonctionnalités :

[{t:(

  • L'URL de remplacement http://localhost:8080/ sera utilisée dans tous les exemples. Veuillez le remplacer par votre URL.
  • Veillez à remplacer les valeurs d'espace réservé (par exemple, path/to/your/file.pdf , certificate_password , etc.) par des valeurs réelles.
  • Les en-têtes author , title et subject sont inclus dans tous les exemples de requêtes.
    @@--BRACKET-FERMETURE--@@

[GET] Vérification de l'état

Point de terminaison : http://localhost:8080/v1/document-services/ping

Point de terminaison de vérification de l'état du serveur pour s'assurer qu'il est en cours d'exécution.

Réponse : 200 OK : pong

[OBTENIR] Vérifier le permis

Point de terminaison : http://localhost:8080/v1/document-services/check-license

Vérifie la validité de la licence.

Réponse : 200 OK : Valid

[POST] Texte expurgé

Point de terminaison : http://localhost:8080/v1/document-services/pdfs/redact-text

Masque les mots sensibles dans un document au format PDF grâce à une véritable fonction de rédaction. Incluez un fichier PDF sous forme d'objet pdf_file dans le corps de la requête.

Paramètres obligatoires du corps de la requête

Nom Type de données Description du projet
`pdf_file` application/fichier pdf Le fichier PDF à expurger.
`words_to_redact` tableau[chaîne] Liste de mots à supprimer du document.

<Le reste du contenu a été omis par souci de concision, mais les mêmes règles de formatage s'appliquent à l'ensemble du document

Questions Fréquemment Posées

Quel est l'objectif de l'API REST IronSecureDoc ?

L'API REST IronSecureDoc est conçue pour aider les développeurs à sécuriser et gérer les documents PDF en fournissant des fonctionnalités telles que l'expurgation de texte, l'application de signatures numériques, le cryptage de documents et la vérification des mots de passe.

Comment puis-je m'assurer que mon serveur est opérationnel en utilisant l'API IronSecureDoc ?

Vous pouvez vous assurer que votre serveur est opérationnel en envoyant une requête GET au point de terminaison `/v1/document-services/ping`. Si elle aboutit, le serveur répondra avec un statut `200 OK` et le message `pong`.

Comment expurger un texte ou des motifs spécifiques dans un PDF en utilisant l'API ?

Vous pouvez expurger un texte ou des motifs spécifiques dans un PDF en envoyant une requête POST au point de terminaison `/v1/document-services/pdfs/redact-text` avec le PDF et le texte ou les expressions régulières que vous souhaitez expurger.

Comment puis-je vérifier si les signatures numériques d'un PDF sont valides ?

Pour vérifier les signatures numériques dans un PDF, vous pouvez envoyer une requête POST au point de terminaison `/v1/document-services/pdfs/verify-signatures` avec le fichier PDF. L'API renverra des informations sur la validité de chaque signature.

Quelles sont les étapes pour chiffrer un PDF en utilisant l'API IronSecureDoc ?

Pour chiffrer un PDF, envoyez une requête POST au point de terminaison `/v1/document-services/pdfs/encrypt` avec le fichier PDF, en spécifiant les mots de passe utilisateur et propriétaire et toutes les autorisations que vous souhaitez définir, telles que l'extraction de contenu ou le remplissage de formulaires.

Comment puis-je signer numériquement un document PDF en utilisant l'API IronSecureDoc ?

Vous pouvez signer numériquement un PDF en envoyant une requête POST au point de terminaison `/v1/document-services/pdfs/certify` avec le fichier PDF, un certificat numérique et le mot de passe du certificat.

Quelles options sont disponibles pour protéger les documents PDF ?

Les options pour protéger les PDF incluent le chiffrement du document, la définition des autorisations d'accès, l'ajout de mots de passe utilisateur et propriétaire, et la vérification des mots de passe existants en utilisant l'API IronSecureDoc.

Est-il possible d'extraire du texte d'un PDF en utilisant l'API IronSecureDoc ?

Oui, vous pouvez extraire du texte d'un PDF en envoyant une requête POST au point de terminaison `/v1/document-services/pdfs/extract`. Vous pouvez spécifier des paramètres pour extraire le texte de certaines pages ou de l'ensemble du document.

Comment puis-je vérifier les mots de passe d'un document PDF ?

Pour vérifier les mots de passe, envoyez une requête POST au point de terminaison `/v1/document-services/pdfs/verify-password` avec le fichier PDF. Incluez à la fois les mots de passe utilisateur et propriétaire dans votre requête pour confirmer leur validité.

Quelles sont les principales capacités de l'API REST IronSecureDoc ?

Les principales capacités de l'API REST IronSecureDoc incluent les vérifications de la santé du serveur, la vérification des licences, l'expurgation de texte, l'application de signatures numériques, le cryptage de PDF et l'extraction de texte.

Curtis Chau
Curtis Chau
  Discutez maintenant avec l'équipe d'ingénierie
Rédacteur technique

Curtis Chau détient un baccalauréat en informatique (Université de Carleton) et se spécialise dans le développement front-end avec expertise en Node.js, TypeScript, JavaScript et React. Passionné par la création d'interfaces utilisateur intuitives et esthétiquement plaisantes, Curtis aime travailler avec des frameworks modernes ...

Lire la suite
Prêt à commencer?
Version: 2024.10 vient de sortir