API REST para IronSecureDoc

Translated

View the article in English

Esta es la referencia de la API REST para su instancia de IronSecureDoc. Este tutorial asume que usted ya tiene una instancia de contenedor en ejecución, si usted está buscando para Para empezar, siga nuestra Guía.

Consejos

El marcador de posición http://localhost:8080/ se utilizará para la URL en todos los ejemplos. Asegúrese de sustituirlo por su URL.
Asegúrese de sustituir los valores del marcador de posición (por ejemplo, ruta/a/tu/archivo.pdf, contraseña_certificado, etc.) con valores reales.
Las cabeceras author, title y subject se incluyen en todos los ejemplos de solicitud.

chequeo [GET]

Endpoint: http://localhost:8080/v1/document-services/ping

Punto final de comprobación de estado para verificar que el servidor está funcionando.

Response: 200 OK: pong

[GET] Comprobar licencia

Endpoint: http://localhost:8080/v1/document-services/check-license

Verifica la validez de la licencia.

Response: 200 OK: Valid

[POST] Redactar texto

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

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

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción

archivo_pdf aplicación/archivo pdf El archivo PDF a redactar.

palabras_a_redactar matriz[cadena] Conjunto de palabras que deben suprimirse del documento.

Parámetros opcionales del cuerpo de la solicitud

Nombre Tipo de datos Por defecto Descripción

contraseña_usuario cadena null Contraseña de usuario para el PDF de entrada. Obligatorio si el PDF tiene una contraseña de usuario para conceder acceso de lectura.

contraseña_propietario cadena null Contraseña de propietario para el PDF de entrada. Obligatorio si el PDF tiene una contraseña de propietario para conceder acceso para realizar modificaciones.

páginas_específicas matriz[int] null Opcionalmente, especifique las páginas a las que se aplicará. Si se deja vacío, se aplicarán todas las páginas.

dibujar_caja_negra bool Verdadero Haga que se dibuje un recuadro negro sobre las áreas de texto redactadas.

coincidir_palabra_completa bool Verdadero Permitir que las coincidencias parciales dentro de las palabras también se redacten.

match_case bool null Coincidencia de mayúsculas y minúsculas para las palabras que deben suprimirse.

superponer_texto cadena null Si prefiere un texto superpuesto en el área de redacción, como palabras o símbolos, configúrelos aquí. Si no se establece, se utilizará un espacio en blanco.

guardar_como_pdfa bool Falso Guarde el PDF con la conformidad PDF/A-3.

guardar_como_pdfua bool Falso Guarde el PDF con conformidad PDF/UA.

Cabeceras opcionales

Nombre Tipo de datos Descripción

autor cadena Establezca la propiedad Autor de metadatos PDF.

título cadena Establezca la propiedad Título de los metadatos PDF.

tema cadena Establezca la propiedad Asunto de los metadatos PDF.

Ejemplo:

Solicitud

Sólo parámetros obligatorios:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="pdf"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="pdf"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \

CURL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="word1"' \
  -F 'words_to_redact="word2"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="REDACTED"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="word1"' \
  -F 'words_to_redact="word2"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="REDACTED"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Respuesta:

200 OK con el archivo PDF redactado adjunto.

[POST] Redactar expresión regular

Endpoint: http://localhost:8080/v1/document-services/pdfs/redact-regular-expression

Oculta las coincidencias sensibles de expresiones regulares (como fechas, nombres o patrones) en un documento en formato PDF utilizando una verdadera redacción. Incluir un archivo PDF como objeto pdf_file en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción

archivo_pdf aplicación/archivo pdf El archivo PDF a redactar.

expresión_regular cadena Expresión regular a partir de la cual se eliminarán del documento los casos coincidentes.