API REST para IronSecureDoc en C

This article was translated from English: Does it need improvement?
Translated
View the article in English

Esta es la Referencia de la API REST para su instancia de IronSecureDoc. Este tutorial asume que ya tiene una instancia de contenedor en ejecución. Si está buscando Comenzar, por favor siga nuestra Guía.

Saltar a las características:

[{t:(

  • El marcador de posición de http://localhost:8080/ se usará para la URL en todos los ejemplos. Por favor asegúrese de reemplazarlo con su URL.
  • Asegúrese de reemplazar los valores de marcador de posición (ej., ruta/a/su/archivo.pdf, contraseña_certificado, etc.) con valores reales.
  • Los encabezados author, title y subject están incluidos en todos los ejemplos de solicitudes.
    @@--CIERRE DE SOPORTE--@@

[GET] Chequeo de salud

Punto final: http://localhost:8080/v1/document-services/ping

Punto final de verificación de salud para verificar que el servidor está funcionando.

Respuesta: 200 OK: pong


[GET] Verificar licencia

Punto final: http://localhost:8080/v1/document-services/check-license

Verifica la validez de la licencia.

Respuesta: 200 OK: Válido


[POST] Redactar texto

Punto final: http://localhost:8080/v1/document-services/pdfs/redact-text

Oculta palabras sensibles en un documento en formato PDF utilizando una verdadera redacción. Incluya un archivo PDF como un objeto pdf_file en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

NombreTipo de datosDescripción
`pdf_file`archivo de solicitud/pdfEl archivo PDF a redactar.
`words_to_redact`matriz[cadena]Una serie de palabras que se eliminarán del documento.

Preguntas Frecuentes

¿Cuál es el propósito de la IronSecureDoc REST API?

La IronSecureDoc REST API está diseñada para ayudar a los desarrolladores a asegurar y gestionar documentos PDF proporcionando funcionalidades como redacción de texto, aplicación de firmas digitales, encriptación de documentos y verificación de contraseñas.

¿Cómo puedo asegurarme de que mi servidor esté operativo usando la API de IronSecureDoc?

Puedes asegurarte de que tu servidor esté operativo enviando una solicitud GET al endpoint `/v1/document-services/ping`. Si tiene éxito, el servidor responderá con un estado `200 OK` y el mensaje `pong`.

¿Cómo redacto texto o patrones específicos en un PDF usando la API?

Puedes redactar texto o patrones específicos en un PDF enviando una solicitud POST al endpoint `/v1/document-services/pdfs/redact-text` con el PDF y los textos o expresiones regulares que deseas redactar.

¿Cómo puedo verificar si las firmas digitales de un PDF son válidas?

Para verificar firmas digitales en un PDF, puedes enviar una solicitud POST al endpoint `/v1/document-services/pdfs/verify-signatures` con el archivo PDF. La API devolverá información sobre la validez de cada firma.

¿Qué pasos están involucrados en encriptar un PDF usando la API de IronSecureDoc?

Para encriptar un PDF, envía una solicitud POST al endpoint `/v1/document-services/pdfs/encrypt` con el archivo PDF, especificando contraseñas de usuario y propietario y cualquier permiso que desees establecer, como extracción de contenido o llenado de formularios.

¿Cómo puedo firmar digitalmente un documento PDF usando la API de IronSecureDoc?

Puedes firmar digitalmente un PDF enviando una solicitud POST al endpoint `/v1/document-services/pdfs/certify` con el archivo PDF, un certificado digital y la contraseña del certificado.

¿Qué opciones están disponibles para proteger documentos PDF?

Las opciones para proteger PDFs incluyen encriptar el documento, establecer permisos de acceso, añadir contraseñas de usuario y propietario, y verificar contraseñas existentes usando la IronSecureDoc API.

¿Es posible extraer texto de un PDF usando la API de IronSecureDoc?

Sí, puedes extraer texto de un PDF enviando una solicitud POST al endpoint `/v1/document-services/pdfs/extract`. Puedes especificar parámetros para extraer texto de ciertas páginas o de todo el documento.

¿Cómo verifico las contraseñas de un documento PDF?

Para verificar contraseñas, envía una solicitud POST al endpoint `/v1/document-services/pdfs/verify-password` con el archivo PDF. Incluye tanto las contraseñas de usuario como de propietario en tu solicitud para confirmar su validez.

¿Cuáles son las principales capacidades de la IronSecureDoc REST API?

Las principales capacidades de la IronSecureDoc REST API incluyen chequeos de salud del servidor, verificación de licencias, redacción de texto, aplicación de firmas digitales, encriptación de PDF y extracción de texto.

Curtis Chau
Escritor Técnico

Curtis Chau tiene una licenciatura en Ciencias de la Computación (Carleton University) y se especializa en el desarrollo front-end con experiencia en Node.js, TypeScript, JavaScript y React. Apasionado por crear interfaces de usuario intuitivas y estéticamente agradables, disfruta trabajando con frameworks modernos y creando manuales bien ...

Leer más
¿Listo para empezar?
Version: 2024.10 recién lanzado