1. IronSecureDoc
  2. Tutoriales
  3. REST API para IronSecureDoc

API REST para IronSecureDoc en C

Curtis Chau
Curtis Chau
Actualizado:
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:

@@--SOPORTE-t-ABIERTO--@@

  • 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 autor, título y sujeto 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 archivo pdf en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción
archivo pdf archivo de solicitud/pdf El archivo PDF a redactar.
palabras_para_redactar matriz[cadena] Una serie de palabras que se eliminarán del documento.

Parámetros opcionales del cuerpo de la solicitud

Nombre Tipo de datos Por defecto Descripción
contraseña de usuario cadena null Contraseña de usuario para el PDF de entrada. Obligatorio si el PDF tiene una contraseña de usuario para permitir el acceso de lectura.
contraseña del propietario cadena null Contraseña de propietario del PDF de entrada. Obligatoria si el PDF tiene una contraseña de propietario para permitir el acceso y realizar modificaciones.
páginas específicas matriz[int] null Opcionalmente, especifique las páginas a las que se aplicará. Si se deja en blanco, se aplicarán todas las páginas.
dibujar_caja_negra bool Verdadero Haga que se dibuje un cuadro negro sobre las áreas de texto redactadas.
coincidir_palabra_completa bool Verdadero También se permiten redactar coincidencias parciales dentro de las palabras.
caso_coincidencia bool null Haga coincidir mayúsculas y minúsculas con las palabras que se van a redactar.
texto superpuesto cadena null Si prefiere superponer texto en el área de redacción, como palabras o símbolos, indíquelo aquí. Si no lo hace, se usará un espacio en blanco.
guardar como pdfa bool FALSO Guarde el PDF con compatibilidad PDF/A-3.
guardar_como_pdfua bool FALSO Guarde el PDF con compatibilidad PDF/UA.

Encabezados 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 metadatos PDF.
sujeto cadena Establezca la propiedad Asunto de metadatos PDF.

Ejemplo:

Request

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 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'palabras_para_redactar=pdf' \
  -F 'dibujar_caja_negra=true' \
  -F 'coincidir_palabra_completa=true' \
  -F 'caso_coincidencia=true' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'palabras_para_redactar=pdf' \
  -F 'dibujar_caja_negra=true' \
  -F 'coincidir_palabra_completa=true' \
  -F 'caso_coincidencia=true' \
SHELL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'palabras_para_redactar=word1' \
  -F 'palabras_para_redactar=word2' \
  -F 'dibujar_caja_negra=true' \
  -F 'coincidir_palabra_completa=true' \
  -F 'caso_coincidencia=true' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'texto superpuesto=REDACTED' \
  -F 'páginas específicas=0' \
  -F 'páginas específicas=1' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'palabras_para_redactar=word1' \
  -F 'palabras_para_redactar=word2' \
  -F 'dibujar_caja_negra=true' \
  -F 'coincidir_palabra_completa=true' \
  -F 'caso_coincidencia=true' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'texto superpuesto=REDACTED' \
  -F 'páginas específicas=0' \
  -F 'páginas específicas=1' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
SHELL

Response:

  • 200 OK con el archivo PDF redactado adjunto.

[POST] Redactar expresión regular

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

Oculta coincidencias de expresión regular sensibles (como fechas, nombres o patrones) en un documento en formato PDF utilizando una verdadera redacción. Incluya un archivo PDF como un objeto archivo pdf en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción
archivo pdf archivo de solicitud/pdf El archivo PDF a redactar.
expresión_regular cadena Expresión regular a partir de la cual se eliminarán los casos coincidentes del documento.

Parámetros opcionales del cuerpo de la solicitud

Nombre Tipo de datos Por defecto Descripción
contraseña de usuario cadena null Contraseña de usuario para el PDF de entrada. Obligatorio si el PDF tiene una contraseña de usuario para permitir el acceso de lectura.
contraseña del propietario cadena null Contraseña de propietario del PDF de entrada. Obligatoria si el PDF tiene una contraseña de propietario para permitir el acceso y realizar modificaciones.
páginas específicas matriz[int] null Opcionalmente, especifique las páginas a las que se aplicará. Si se deja en blanco, se aplicarán todas las páginas.
dibujar_caja_negra bool Verdadero Haga que se dibuje un cuadro negro sobre las áreas de texto redactadas.
texto superpuesto cadena null Si prefiere superponer texto en el área de redacción, como palabras o símbolos, indíquelo aquí. Si no lo hace, se usará un espacio en blanco.
guardar como pdfa bool FALSO Guarde el PDF con compatibilidad PDF/A-3.
guardar_como_pdfua bool FALSO Guarde el PDF con compatibilidad PDF/UA.

Encabezados 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 metadatos PDF.
sujeto cadena Establezca la propiedad Asunto de metadatos PDF.

Ejemplo:

Request

Sólo parámetros obligatorios:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'expresión_regular="[0-9]"' \
  -F 'dibujar_caja_negra=true' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'expresión_regular="[0-9]"' \
  -F 'dibujar_caja_negra=true' \
SHELL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'expresión_regular="[0-9]"' \
  -F 'dibujar_caja_negra=true' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'texto superpuesto=*' \
  -F 'páginas específicas=0' \
  -F 'páginas específicas=1' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'expresión_regular="[0-9]"' \
  -F 'dibujar_caja_negra=true' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'texto superpuesto=*' \
  -F 'páginas específicas=0' \
  -F 'páginas específicas=1' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
SHELL

Response:

  • 200 OK con el archivo PDF redactado adjunto.

[POST] Redactar región

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

Oculta texto sensible en una región específica de un documento PDF usando redacción verdadera. Incluya un archivo PDF como un objeto archivo pdf en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción
archivo pdf archivo de solicitud/pdf El archivo PDF a redactar.
región_a_redactar_x float Coordenada X de la región a redactar, comenzando desde la parte inferior izquierda de la página.
región_a_redactar_y float Coordenada Y de la región a redactar, comenzando desde la parte inferior izquierda de la página.
región_a_redactar_w float Ancho de la región a redactar, comenzando desde la coordenada X especificada.
región_a_redactar_h float Altura de la región a redactar, a partir de la coordenada Y especificada.

Parámetros opcionales del cuerpo de la solicitud

Nombre Tipo de datos Por defecto Descripción
contraseña de usuario cadena null Contraseña de usuario para el PDF de entrada. Obligatorio si el PDF tiene una contraseña de usuario para permitir el acceso de lectura.
contraseña del propietario cadena null Contraseña de propietario del PDF de entrada. Obligatoria si el PDF tiene una contraseña de propietario para permitir el acceso y realizar modificaciones.
páginas específicas matriz[int] null Opcionalmente, especifique las páginas a las que se aplicará. Si se deja en blanco, se aplicarán todas las páginas.
dibujar_caja_negra bool Verdadero Haga que se dibuje un cuadro negro sobre las áreas de texto redactadas.
guardar como pdfa bool FALSO Guarde el PDF con compatibilidad PDF/A-3.
guardar_como_pdfua bool FALSO Guarde el PDF con compatibilidad PDF/UA.

Encabezados 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 metadatos PDF.
sujeto cadena Establezca la propiedad Asunto de metadatos PDF.

Ejemplo:

Request

Sólo parámetros obligatorios:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'región_a_redactar_x=100' \
  -F 'región_a_redactar_y=150' \
  -F 'región_a_redactar_w=500' \
  -F 'región_a_redactar_h=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'región_a_redactar_x=100' \
  -F 'región_a_redactar_y=150' \
  -F 'región_a_redactar_w=500' \
  -F 'región_a_redactar_h=400' \
SHELL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'región_a_redactar_x=100' \
  -F 'región_a_redactar_y=150' \
  -F 'región_a_redactar_w=500' \
  -F 'región_a_redactar_h=400' \
  -F 'páginas específicas=0' \
  -F 'páginas específicas=1' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'región_a_redactar_x=100' \
  -F 'región_a_redactar_y=150' \
  -F 'región_a_redactar_w=500' \
  -F 'región_a_redactar_h=400' \
  -F 'páginas específicas=0' \
  -F 'páginas específicas=1' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
SHELL

Response:

  • 200 OK con el archivo PDF redactado adjunto.

[POST] Certificar/Aplicar Firma Digital

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

Agrega una certificación a un documento PDF para afirmar que no ha sido manipulado mediante un archivo de Certificado (.p12, .pfx). Incluya un archivo PDF como un objeto archivo pdf en el cuerpo de la solicitud, y un archivo de certificado como un objeto certificate_file en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción
archivo pdf archivo de solicitud/pdf El archivo PDF para certificar.
certificate_file archivo application/x-pkcs12 El archivo de certificado (.p12, .pfx) que se utilizará para la certificación.
contraseña del certificado cadena Contraseña para el archivo de certificado proporcionado.
permisos_de_certificado int
valor de certificados_permisos Permisos
1 No se permiten cambios. Cualquier cambio adicional en el documento invalidará la firma.
2 Solo se permiten firmas adicionales y completar formularios.
3 Solo se permiten firmas adicionales, llenado de formularios y anotaciones

Parámetros opcionales del cuerpo de la solicitud

Nombre Tipo de datos Por defecto Descripción
contraseña de usuario cadena null Contraseña de usuario para el PDF de entrada. Obligatorio si el PDF tiene una contraseña de usuario para permitir el acceso de lectura.
contraseña del propietario cadena null Contraseña de propietario del PDF de entrada. Obligatoria si el PDF tiene una contraseña de propietario para permitir el acceso y realizar modificaciones.
guardar como pdfa bool FALSO Guarde el PDF con compatibilidad PDF/A-3.
guardar_como_pdfua bool FALSO Guarde el PDF con compatibilidad PDF/UA.

Encabezados 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 metadatos PDF.
sujeto cadena Establezca la propiedad Asunto de metadatos PDF.

Ejemplo:

Request

Sólo parámetros obligatorios:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'contraseña del certificado=p4ssw0rd' \
  -F 'permisos_de_certificado=1' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'contraseña del certificado=p4ssw0rd' \
  -F 'permisos_de_certificado=1' \
SHELL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'contraseña del certificado=p4ssw0rd' \
  -F 'permisos_de_certificado=1' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'contraseña del certificado=p4ssw0rd' \
  -F 'permisos_de_certificado=1' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
SHELL

Response:

  • 200 OK con el archivo PDF certificado adjunto.

[POST] Firma con Firma y Certificado

Endpoint: http://localhost:8080/v1/document-services/pdfs/sign

Añade una imagen y certificación a esa imagen en un documento PDF para afirmar que no ha sido manipulado mediante un archivo de certificado (.p12, .pfx). Incluya un archivo PDF como un objeto archivo pdf en el cuerpo de la solicitud, y un archivo de certificado como un objeto certificate_file en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción
archivo pdf archivo de solicitud/pdf El archivo PDF para certificar.
archivo de imagen de firma archivo image/jpeg o image/png La imagen de la firma (.png, .jpg, .jpeg) que se usará para la certificación. Puede ser un logotipo, un autógrafo, etc.
certificate_file archivo application/x-pkcs12 El archivo de certificado (.p12, .pfx) que se utilizará para la certificación.
contraseña del certificado cadena Contraseña para el archivo de certificado proporcionado.
permisos_de_certificado int
valor de certificados_permisos Permisos
1 No se permiten cambios. Cualquier cambio adicional en el documento invalidará la firma.
2 Solo se permiten firmas adicionales y completar formularios.
3 Solo se permiten firmas adicionales, llenado de formularios y anotaciones

página específica del signo int Especifique la página donde se aplicará la imagen y el certificado. La primera página es 0. Si se deja vacío, solo se aplicará la primera página.
imagen_de_firma_x float La coordenada X de la región del rectángulo de la imagen de la firma. Comienza en la esquina superior izquierda de la página.
imagen_de_firma_y float La coordenada Y de la región del rectángulo de la imagen de la firma. Comienza en la esquina superior izquierda de la página.
imagen de firma_w float El ancho del rectángulo de la imagen de la firma. Comienza desde la esquina superior izquierda de la página.
imagen_de_firma_h float La altura del rectángulo de la imagen de la firma. Comienza en la esquina superior izquierda de la página.

Parámetros opcionales del cuerpo de la solicitud

Nombre Tipo de datos Por defecto Descripción
contraseña de usuario cadena null Contraseña de usuario para el PDF de entrada. Obligatorio si el PDF tiene una contraseña de usuario para permitir el acceso de lectura.
contraseña del propietario cadena null Contraseña de propietario del PDF de entrada. Obligatoria si el PDF tiene una contraseña de propietario para permitir el acceso y realizar modificaciones.
páginas específicas matriz[int] null Opcionalmente, especifique las páginas a las que se aplicará. Si se deja en blanco, se aplicarán todas las páginas.
guardar como pdfa bool FALSO Guarde el PDF con compatibilidad PDF/A-3.
guardar_como_pdfua bool FALSO Guarde el PDF con compatibilidad PDF/UA.

Encabezados 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 metadatos PDF.
sujeto cadena Establezca la propiedad Asunto de metadatos PDF.

Ejemplo:

Request

Sólo parámetros obligatorios:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'archivo de imagen de firma=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'contraseña del certificado=p4ssw0rd' \
  -F 'permisos_de_certificado=1' \
  -F 'página específica del signo=0' \
  -F 'imagen_de_firma_x=100' \
  -F 'imagen_de_firma_y=150' \
  -F 'imagen de firma_w=500' \
  -F 'imagen_de_firma_h=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'archivo de imagen de firma=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'contraseña del certificado=p4ssw0rd' \
  -F 'permisos_de_certificado=1' \
  -F 'página específica del signo=0' \
  -F 'imagen_de_firma_x=100' \
  -F 'imagen_de_firma_y=150' \
  -F 'imagen de firma_w=500' \
  -F 'imagen_de_firma_h=400' \
SHELL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'archivo de imagen de firma=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'contraseña del certificado=p4ssw0rd' \
  -F 'permisos_de_certificado=1' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
  -F 'página específica del signo=0' \
  -F 'imagen_de_firma_x=100' \
  -F 'imagen_de_firma_y=150' \
  -F 'imagen de firma_w=500' \
  -F 'imagen_de_firma_h=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'archivo de imagen de firma=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'contraseña del certificado=p4ssw0rd' \
  -F 'permisos_de_certificado=1' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
  -F 'página específica del signo=0' \
  -F 'imagen_de_firma_x=100' \
  -F 'imagen_de_firma_y=150' \
  -F 'imagen de firma_w=500' \
  -F 'imagen_de_firma_h=400' \
SHELL

Response:

  • 200 OK con el archivo PDF certificado adjunto.

[POST] Verificar firmas

Punto final: http://localhost:8080/v1/document-services/pdfs/verify-signatures

Verifica que las firmas dentro del archivo PDF sean válidas.

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción
archivo pdf archivo de solicitud/pdf El archivo PDF a cifrar.

Parámetros opcionales del cuerpo de la solicitud

Nombre Tipo de datos Por defecto Descripción
contraseña de usuario cadena null Contraseña de usuario para el PDF de entrada. Obligatorio si el PDF tiene una contraseña de usuario para permitir el acceso de lectura.
contraseña del propietario cadena null Contraseña de propietario del PDF de entrada. Obligatoria si el PDF tiene una contraseña de propietario para permitir el acceso y realizar modificaciones.

Ejemplo:

Request

Sólo parámetros obligatorios:

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
YAML

Todos los parámetros obligatorios y opcionales:

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
YAML

Response:

  • 200 OK si hay firmas y todas son válidas
  • 400 Solicitud incorrecta si no hay firmas o al menos una es inválida.

[POST] Cifrar/Agregar contraseña y permisos

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

Agrega una capa de seguridad a un documento PDF cifrándolo con una contraseña de usuario y propietario. Incluya un archivo PDF como un objeto archivo pdf en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción
archivo pdf archivo de solicitud/pdf El archivo PDF a cifrar.
permitir_extraer_contenido bool Permitir la extracción de contenido del archivo PDF.
permitir_rellenar_formularios bool Permitir el llenado de formularios en el PDF resultante.
permitir_anotaciones bool Permitir la adición o modificación de anotaciones en el PDF resultante.
permitir_impresión bool Permitir la impresión del PDF resultante.
permitir_modificaciones bool Permitir modificaciones al PDF resultante.
nueva_contraseña_de_propietario cadena Nueva contraseña de propietario para el PDF de salida. Otorga acceso completo, incluyendo la modificación de permisos y contraseñas.

Parámetros opcionales del cuerpo de la solicitud

Nombre Tipo de datos Por defecto Descripción
contraseña de usuario cadena null Contraseña de usuario para el PDF de entrada. Obligatorio si el PDF tiene una contraseña de usuario para permitir el acceso de lectura.
contraseña del propietario cadena null Contraseña de propietario del PDF de entrada. Obligatoria si el PDF tiene una contraseña de propietario para permitir el acceso y realizar modificaciones.
nueva_contraseña_de_usuario cadena null Nueva contraseña de usuario para el PDF de salida. Otorga acceso de lectura y otros permisos especificados.
guardar como pdfa bool FALSO Guarde el PDF con compatibilidad PDF/A-3.
guardar_como_pdfua bool FALSO Guarde el PDF con compatibilidad PDF/UA.

Encabezados 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 metadatos PDF.
sujeto cadena Establezca la propiedad Asunto de metadatos PDF.

Ejemplo:

Request

Sólo parámetros obligatorios:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'permitir_extraer_contenido=true' \
  -F 'permitir_rellenar_formularios=true' \
  -F 'permitir_anotaciones=true' \
  -F 'permitir_impresión=true' \
  -F 'permitir_modificaciones=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'permitir_extraer_contenido=true' \
  -F 'permitir_rellenar_formularios=true' \
  -F 'permitir_anotaciones=true' \
  -F 'permitir_impresión=true' \
  -F 'permitir_modificaciones=false' \
SHELL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'permitir_extraer_contenido=true' \
  -F 'permitir_rellenar_formularios=true' \
  -F 'permitir_anotaciones=true' \
  -F 'permitir_impresión=true' \
  -F 'permitir_modificaciones=false' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'nueva_contraseña_de_usuario=p4ssw0rd' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'permitir_extraer_contenido=true' \
  -F 'permitir_rellenar_formularios=true' \
  -F 'permitir_anotaciones=true' \
  -F 'permitir_impresión=true' \
  -F 'permitir_modificaciones=false' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'nueva_contraseña_de_usuario=p4ssw0rd' \
  -F 'guardar como pdfa=false' \
  -F 'guardar_como_pdfua=false' \
SHELL

Response:

  • 200 OK con el archivo PDF cifrado adjunto.

[POST] Extraer texto de un documento

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

Extrae texto embebido en las páginas de un documento. Incluya un archivo PDF como un objeto archivo pdf en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción
archivo pdf archivo de solicitud/pdf El archivo PDF a cifrar.

Parámetros opcionales del cuerpo de la solicitud

Nombre Tipo de datos Por defecto Descripción
contraseña de usuario cadena null Contraseña de usuario para el PDF de entrada. Obligatorio si el PDF tiene una contraseña de usuario para permitir el acceso de lectura.
contraseña del propietario cadena null Contraseña de propietario del PDF de entrada. Obligatoria si el PDF tiene una contraseña de propietario para permitir el acceso y realizar modificaciones.
páginas específicas matriz[int] null Opcionalmente, especifique las páginas a las que se aplicará. Si se deja en blanco, se aplicarán todas las páginas.

Ejemplo:

Request

Sólo parámetros obligatorios:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
SHELL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'páginas específicas=0' \
  -F 'páginas específicas=1' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
  -F 'páginas específicas=0' \
  -F 'páginas específicas=1' \
SHELL

Response:

  • 200 OK con el texto extraído como respuesta.

[POST] Verificar contraseña del documento

Punto final: http://localhost:8080/v1/document-services/pdfs/verify-password

Verifica que las contraseñas de usuario y propietario suministradas sean válidas para el archivo pdf.

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción
archivo pdf archivo de solicitud/pdf El archivo PDF.
contraseña de usuario cadena Contraseña de usuario para el PDF de entrada. Obligatorio si el PDF tiene una contraseña de usuario para permitir el acceso de lectura.
contraseña del propietario cadena Contraseña del propietario para el PDF de entrada.

Ejemplo:

Request

Sólo parámetros obligatorios:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H 'autor: Iron Software | IRONSECUREDOC' \
  -H 'título: WEBSITE DEMO 2024' \
  -H 'sujeto: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'archivo pdf=@sample.pdf;type=application/pdf' \
  -F 'contraseña de usuario=password' \
  -F 'contraseña del propietario=5yug2RT45th32h78' \
SHELL

Response:

  • 200 OK

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
Curtis Chau
  Chatea con el equipo de ingeniería ahora
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