API REST para IronSecureDoc

Chaknith Bin

20 de julio, 2024

Actualizado 20 de octubre, 2024

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 paraPara empezar, siga nuestra Guía.

Saltar a características:

-Verificar clave de licencia

Funcionalidad de Redacción de PDF
-Drafting text
-Escribir expresión regular
-Redactar región
Funcionalidad de Firmar PDF
-Certificar PDF / Aplicar Firma Digital
-Firmar PDF / Aplicar imagen de firma
-Verificar Certificados / Firmas
Funcionalidad de Protección de PDF
-Encriptar / Añadir contraseña al PDF
-Establecer permisos de PDF
-Verificar contraseñ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 dato	Descripción
archivo_pdf	archivo application/pdf	El archivo PDF a redactar.
palabras_a_redactar	array[string]	Una matriz de palabras que deben ser eliminadas del documento.

Parámetros opcionales del cuerpo de la solicitud

Nombre	Tipo de dato	Por defecto	Descripción
contraseña_de_usuario	cadena	nulo	Contraseña de usuario para el PDF de entrada. Requerida si el PDF tiene una contraseña de usuario para conceder acceso de lectura.
contraseña_del_propietario	cadena	nulo	Contraseña de propietario para el PDF de entrada. Se requiere si el PDF tiene una contraseña de propietario para otorgar acceso para hacer modificaciones.
páginas_específicas	matriz[int]	nulo	Opcionalmente, especifique las páginas a las que se aplicará. Si se deja vacío, se aplicará a todas las páginas.
draw_black_box	bool	Verdadero	Tenga una caja negra dibujada sobre las áreas de texto redactadas.
coincidir_palabra_completa	bool	Verdadero	Permitir que se redaccionen también coincidencias parciales dentro de las palabras.
coincidir_mayúsculas_y_minúsculas	bool	nulo	Coincidir mayúsculas y minúsculas para las palabras a ser redactadas.
texto_superpuesto	cadena	nulo	Si prefiere un texto superpuesto en el área de redacción, como palabras o símbolos, establézcalo aquí. Si no se establece, se usará un carácter en blanco.
guardar_como_pdfa	bool	Falso	Guarde el PDF con cumplimiento PDF/A-3.
save_as_pdfua	bool	Falso	Guarda el PDF con cumplimiento PDF/UA.

Cabeceras opcionales

Nombre	Tipo de dato	Descripción
autor	cadena	Establece la propiedad de autor de los metadatos del PDF.
título	cadena	Establecer la propiedad del título de los metadatos del PDF.
asunto	cadena	Establecer la propiedad de Asunto de los metadatos del 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 dato	Descripción
archivo_pdf	archivo application/pdf	El archivo PDF a redactar.
expresión_regular	cadena	Expresión regular a partir de la cual los casos coincidentes serán redactados del documento.

Parámetros opcionales del cuerpo de la solicitud

Nombre	Tipo de dato	Por defecto	Descripción
contraseña_de_usuario	cadena	nulo	Contraseña de usuario para el PDF de entrada. Requerida si el PDF tiene una contraseña de usuario para conceder acceso de lectura.
contraseña_del_propietario	cadena	nulo	Contraseña de propietario para el PDF de entrada. Se requiere si el PDF tiene una contraseña de propietario para otorgar acceso para hacer modificaciones.
páginas_específicas	matriz[int]	nulo	Opcionalmente, especifique las páginas a las que se aplicará. Si se deja vacío, se aplicará a todas las páginas.
draw_black_box	bool	Verdadero	Tenga una caja negra dibujada sobre las áreas de texto redactadas.
texto_superpuesto	cadena	nulo	Si prefiere un texto superpuesto en el área de redacción, como palabras o símbolos, establézcalo aquí. Si no se establece, se usará un carácter en blanco.
guardar_como_pdfa	bool	Falso	Guarde el PDF con cumplimiento PDF/A-3.
save_as_pdfua	bool	Falso	Guarda el PDF con cumplimiento PDF/UA.

Cabeceras opcionales

Nombre	Tipo de dato	Descripción
autor	cadena	Establece la propiedad de autor de los metadatos del PDF.
título	cadena	Establecer la propiedad del título de los metadatos del PDF.
asunto	cadena	Establecer la propiedad de Asunto de los metadatos del PDF.

Ejemplo:

Solicitud

Sólo parámetros obligatorios:

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -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 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -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 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \

CURL

Todos los parámetros obligatorios y opcionales:

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -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 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="%2A"' \
  -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-regular-expression' \
  -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 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="%2A"' \
  -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 región

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

Descripción: Oculta texto sensible en una región específica de un documento PDF utilizando la 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 dato	Descripción
archivo_pdf	archivo application/pdf	El archivo PDF a redactar.
región_a_redactar_x	float	Coordenada X de la región a redactar, comenzando desde la esquina inferior izquierda de la página.
region_to_redact_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	Anchura 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, comenzando desde la coordenada Y especificada.

Parámetros opcionales del cuerpo de la solicitud

Nombre	Tipo de dato	Por defecto	Descripción
contraseña_de_usuario	cadena	nulo	Contraseña de usuario para el PDF de entrada. Requerida si el PDF tiene una contraseña de usuario para conceder acceso de lectura.
contraseña_del_propietario	cadena	nulo	Contraseña de propietario para el PDF de entrada. Se requiere si el PDF tiene una contraseña de propietario para otorgar acceso para hacer modificaciones.
páginas_específicas	matriz[int]	nulo	Opcionalmente, especifique las páginas a las que se aplicará. Si se deja vacío, se aplicará a todas las páginas.
draw_black_box	bool	Verdadero	Tenga una caja negra dibujada sobre las áreas de texto redactadas.
guardar_como_pdfa	bool	Falso	Guarde el PDF con cumplimiento PDF/A-3.
save_as_pdfua	bool	Falso	Guarda el PDF con cumplimiento PDF/UA.

Cabeceras opcionales

Nombre	Tipo de dato	Descripción
autor	cadena	Establece la propiedad de autor de los metadatos del PDF.
título	cadena	Establecer la propiedad del título de los metadatos del PDF.
asunto	cadena	Establecer la propiedad de Asunto de los metadatos del PDF.

Ejemplo:

Solicitud

Sólo parámetros obligatorios:

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -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 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -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 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \

CURL

Todos los parámetros obligatorios y opcionales:

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -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 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
  -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-region' \
  -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 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
  -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] Certificar / Aplicar firma digital

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

Descripción: Añade 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 objeto pdf_file en el cuerpo de la solicitud, y un archivo de certificado como objeto certificate_file en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Nombre

Tipo de dato

Descripción

archivo_pdf

archivo application/pdf

El archivo PDF para certificar.

archivo_certificado

archivo application/x-pkcs12

El archivo de certificado (.p12, .pfx) para usar en la certificación.

contraseña_del_certificado

cadena

Contraseña para el archivo de certificado proporcionado.

permisos_del_certificado

int

valor de certificate_permissions	Permisos
	No se permiten cambios. Cualquier cambio adicional en el documento invalidará la firma.
	Solo se permiten firmas adicionales y el llenado de formularios.
	Solo se permiten firmas adicionales, relleno de formularios y anotaciones.

Parámetros opcionales del cuerpo de la solicitud

Nombre	Tipo de dato	Por defecto	Descripción
contraseña_de_usuario	cadena	nulo	Contraseña de usuario para el PDF de entrada. Requerida si el PDF tiene una contraseña de usuario para conceder acceso de lectura.
contraseña_del_propietario	cadena	nulo	Contraseña de propietario para el PDF de entrada. Se requiere si el PDF tiene una contraseña de propietario para otorgar acceso para hacer modificaciones.
guardar_como_pdfa	bool	Falso	Guarde el PDF con cumplimiento PDF/A-3.
save_as_pdfua	bool	Falso	Guarda el PDF con cumplimiento PDF/UA.

Cabeceras opcionales

Nombre	Tipo de dato	Descripción
autor	cadena	Establece la propiedad de autor de los metadatos del PDF.
título	cadena	Establecer la propiedad del título de los metadatos del PDF.
asunto	cadena	Establecer la propiedad de Asunto de los metadatos del PDF.

Ejemplo:

Solicitud

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 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \

CURL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -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 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -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 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Respuesta:

200 OK con el archivo PDF certificado adjunto.

[POST] Firmar con Firma y Certificado

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

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

Parámetros obligatorios del cuerpo de la solicitud

Nombre

Tipo de dato

Descripción

archivo_pdf

archivo application/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) para usar en la certificación. Puede ser un logotipo, autógrafo, etc.

archivo_certificado

archivo application/x-pkcs12

El archivo de certificado (.p12, .pfx) para usar en la certificación.

contraseña_del_certificado

cadena

Contraseña para el archivo de certificado proporcionado.

permisos_del_certificado

int

valor de certificate_permissions	Permisos
	No se permiten cambios. Cualquier cambio adicional en el documento invalidará la firma.
	Solo se permiten firmas adicionales y el llenado de formularios.
	Solo se permiten firmas adicionales, relleno de formularios y anotaciones.

sign_specific_page

int

Especifique la página a la que desea aplicar la imagen y el certificado. La primera página es 0. Si se deja vacío, solo se aplicará a la primera página.

signature_image_x

float

La coordenada X de la región Rectangular de la imagen de la firma. Esto comienza desde 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. Esto comienza desde la esquina superior izquierda de la página.

signature_image_w

float

La anchura de la región del rectángulo de la imagen de la firma. Esto comienza desde la esquina superior izquierda de la página.

imagen_de_firma_h

float

La altura de la región del rectángulo de la imagen de la firma. Esto comienza desde la esquina superior izquierda de la página.

Parámetros opcionales del cuerpo de la solicitud

Nombre	Tipo de dato	Por defecto	Descripción
contraseña_de_usuario	cadena	nulo	Contraseña de usuario para el PDF de entrada. Requerida si el PDF tiene una contraseña de usuario para conceder acceso de lectura.
contraseña_del_propietario	cadena	nulo	Contraseña de propietario para el PDF de entrada. Se requiere si el PDF tiene una contraseña de propietario para otorgar acceso para hacer modificaciones.
páginas_específicas	matriz[int]	nulo	Opcionalmente, especifique las páginas a las que se aplicará. Si se deja vacío, se aplicará a todas las páginas.
guardar_como_pdfa	bool	Falso	Guarde el PDF con cumplimiento PDF/A-3.
save_as_pdfua	bool	Falso	Guarda el PDF con cumplimiento PDF/UA.

Cabeceras opcionales

Nombre	Tipo de dato	Descripción
autor	cadena	Establece la propiedad de autor de los metadatos del PDF.
título	cadena	Establecer la propiedad del título de los metadatos del PDF.
asunto	cadena	Establecer la propiedad de Asunto de los metadatos del PDF.

Ejemplo:

Solicitud

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 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'signature_image_file=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'signature_image_file=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

CURL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -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 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=0' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -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 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=0' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

CURL

Respuesta:

200 OK con el archivo PDF certificado adjunto.

[POST] Verificar Firmas

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

Descripción: Verifica que la contraseña de usuario y la contraseña de propietario suministradas sean válidas para el pdf_file.

Parámetros obligatorios del cuerpo de la solicitud

Nombre	Tipo de dato	Descripción
archivo_pdf	archivo application/pdf	El archivo PDF para cifrar.

Parámetros opcionales del cuerpo de la solicitud

Nombre	Tipo de dato	Por defecto	Descripción
contraseña_de_usuario	cadena	nulo	Contraseña de usuario para el PDF de entrada. Requerida si el PDF tiene una contraseña de usuario para conceder acceso de lectura.
contraseña_del_propietario	cadena	nulo	Contraseña de propietario para el PDF de entrada. Se requiere si el PDF tiene una contraseña de propietario para otorgar acceso para hacer modificaciones.

Ejemplo:

Solicitud

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 'pdf_file=@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 'pdf_file=@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 '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 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -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 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

YAML

Respuesta:

200 OK si hay firmas y todas son Válidas
Resultado 400 BadRequest si no hay firmas o al menos una es inválida.

[POST] Cifrar / Añadir contraseña y permisos

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

Descripción: Añade una capa de seguridad a un documento PDF cifrándolo con una contraseña de usuario y propietario. 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 dato	Descripción
archivo_pdf	archivo application/pdf	El archivo PDF para cifrar.
permitir_extraer_contenido	bool	Permita 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_propietario	cadena	Nueva contraseña de propietario para el PDF de salida. Otorga acceso completo, incluyendo cambiar permisos y contraseñas.

Parámetros opcionales del cuerpo de la solicitud

Nombre	Tipo de dato	Por defecto	Descripción
contraseña_de_usuario	cadena	nulo	Contraseña de usuario para el PDF de entrada. Requerida si el PDF tiene una contraseña de usuario para conceder acceso de lectura.
contraseña_del_propietario	cadena	nulo	Contraseña de propietario para el PDF de entrada. Se requiere si el PDF tiene una contraseña de propietario para otorgar acceso para hacer modificaciones.
nueva_contraseña_de_usuario	cadena	nulo	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 cumplimiento PDF/A-3.
save_as_pdfua	bool	Falso	Guarda el PDF con cumplimiento PDF/UA.

Cabeceras opcionales

Nombre	Tipo de dato	Descripción
autor	cadena	Establece la propiedad de autor de los metadatos del PDF.
título	cadena	Establecer la propiedad del título de los metadatos del PDF.
asunto	cadena	Establecer la propiedad de Asunto de los metadatos del PDF.

Ejemplo:

Solicitud

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 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \

CURL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -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 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'new_user_password="p4ssw0rd"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -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 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'new_user_password="p4ssw0rd"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Respuesta:

200 OK con el archivo PDF encriptado adjunto.

[POST] Extraer texto de un documento

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

Descripción: Extrae el texto incrustado en las páginas de un documento. 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 dato	Descripción
archivo_pdf	archivo application/pdf	El archivo PDF para cifrar.

Parámetros opcionales del cuerpo de la solicitud

Nombre	Tipo de dato	Por defecto	Descripción
contraseña_de_usuario	cadena	nulo	Contraseña de usuario para el PDF de entrada. Requerida si el PDF tiene una contraseña de usuario para conceder acceso de lectura.
contraseña_del_propietario	cadena	nulo	Contraseña de propietario para el PDF de entrada. Se requiere si el PDF tiene una contraseña de propietario para otorgar acceso para hacer modificaciones.
páginas_específicas	matriz[int]	nulo	Opcionalmente, especifique las páginas a las que se aplicará. Si se deja vacío, se aplicará a todas las páginas.

Ejemplo:

Solicitud

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 'pdf_file=@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 'pdf_file=@sample.pdf;type=application/pdf' \

CURL

Todos los parámetros obligatorios y opcionales:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -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 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -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 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \

CURL

Respuesta:

200 OK con el texto extraído como respuesta.

[POST] Verificar la Contraseña del Documento

Endpoint: http://localhost:8080/v1/document-services/pdfs/verificar-contraseña

Descripción: Verifica que la contraseña de usuario y la contraseña de propietario suministradas sean válidas para el pdf_file.

Parámetros obligatorios del cuerpo de la solicitud

Nombre	Tipo de dato	Descripción
archivo_pdf	archivo application/pdf	El archivo PDF.
contraseña_de_usuario	cadena	Contraseña de usuario para el PDF de entrada. Requerida si el PDF tiene una contraseña de usuario para conceder acceso de lectura.
contraseña_del_propietario	cadena	Contraseña de propietario para el PDF de entrada.

Ejemplo:

Solicitud

Sólo parámetros obligatorios:

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-password' \
  -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 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-password' \
  -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 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

YAML

Respuesta:

200 OK

Chaknith Bin

Chatea con el equipo de ingeniería ahora

Ingeniero de software

Chaknith trabaja en IronXL e IronBarcode. Tiene una gran experiencia en C# y .NET, ayudando a mejorar el software y a apoyar a los clientes. Sus conocimientos de las interacciones con los usuarios contribuyen a mejorar los productos, la documentación y la experiencia general.