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 ya tienes una instancia de contenedor en funcionamiento, si estás buscando Comenzar, por favor sigue nuestra Guía.

Saltar a características:

Verificar Clave de Licencia
Funcionalidad de Redacción de PDF
- Redactar Texto
- Redactar 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
[{t:(
El marcador de posición de http://localhost:8080/ se utilizará para la URL en todos los ejemplos. Asegúrese de sustituirlo por su URL.
Asegúrese de reemplazar los valores de marcador de posición (por ejemplo, path/to/your/file.pdf, certificate_password, etc.) con valores reales.
Los encabezados author, title y subject están incluidos en todos los ejemplos de solicitud.

chequeo [GET]

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

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

Respuesta: 200 OK: pong

[GET] Comprobar 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 mediante 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

Nombre	Tipo de Datos	Descripción
pdf_file	archivo application/pdf	El archivo PDF para redactar.
words_to_redact	array[string]	Un arreglo de palabras para redactar del documento.

Parámetros opcionales del cuerpo de la solicitud

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.
draw_black_box	bool	True	Have a Black Box drawn over redacted text areas.
match_whole_word	bool	True	Allow partial matches within words be redacted too.
match_case	bool	null	Match case for the words to be redacted.
overlay_text	string	null	If your prefer an Overlay Text on the redaction area such as words or symbols, set them here. If not set, a blank character will be used.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

Cabeceras opcionales

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

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 coincidencias sensibles de Expresiones Regulares (como fechas, nombres o patrones) en un documento en formato PDF utilizando verdadero redactado. Incluya un archivo PDF como un objeto pdf_file en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to redact.
regular_expression	string	Regular Expression from which matching cases will be redacted from the document.

Parámetros opcionales del cuerpo de la solicitud

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.
draw_black_box	bool	True	Have a Black Box drawn over redacted text areas.
overlay_text	string	null	If your prefer an Overlay Text on the redaction area such as words or symbols, set them here. If not set, a blank character will be used.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

Cabeceras opcionales

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

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

Punto final: 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 redacción verdadera. Incluya un archivo PDF como un objeto pdf_file en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Nombre	Tipo de Dato	Descripción
pdf_file	archivo application/pdf	El archivo PDF a redactar.
region_to_redact_x	float	Coordenada X de la región a redactar, comenzando desde la parte 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.
region_to_redact_w	float	Anchura de la región a redactar, comenzando desde la coordenada X especificada.
region_to_redact_h	float	Altura de la región a redactar, comenzando desde la coordenada Y especificada.

Parámetros opcionales del cuerpo de la solicitud

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.
draw_black_box	bool	True	Have a Black Box drawn over redacted text areas.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

Cabeceras opcionales

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

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

Punto final: 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 un objeto pdf_file 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

Name

Data Type

Description

pdf_file

application/pdf file

The PDF file to certify.

certificate_file

application/x-pkcs12 file

The certificate file (.p12, .pfx) to use for certification.

certificate_password

string

Password for the provided certificate file.

certificate_permissions

int

certificate_permissions value	Permissions
1	No Changes Allowed. Any further document changes will invalidate the signature.
2	Only Additional Signatures and Form Filling Allowed.
3	Only AdditionalSignatures, Form Filling, and Annotations Allowed

Parámetros opcionales del cuerpo de la solicitud

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

Cabeceras opcionales

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

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: Agrega una imagen y certificación a esa imagen en un documento PDF para asegurar que no ha sido manipulado mediante un archivo de Certificado (.p12, .pfx). Incluya un archivo PDF como un objeto pdf_file 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

Name

Data Type

Description

pdf_file

application/pdf file

The PDF file to certify.

signature_image_file

image/jpeg or image/png file

The signature image (.png, .jpg, .jpeg) to use for certification. Can be a logo, autograph, etc.

certificate_file

application/x-pkcs12 file

The certificate file (.p12, .pfx) to use for certification.

certificate_password

string

Password for the provided certificate file.

certificate_permissions

int

certificate_permissions value	Permissions
1	No Changes Allowed. Any further document changes will invalidate the signature.
2	Only Additional Signatures and Form Filling Allowed.
3	Only AdditionalSignatures, Form Filling, and Annotations Allowed

sign_specific_page

int

Specify page to apply the image and certificate to. First page is 0. If left empty, only first page will apply.

signature_image_x

float

The X coordinate of the Rectangle region of the signature image. This starts from the top-left of the page.

signature_image_y

float

The Y coordinate of the Rectangle region of the signature image. This starts from the top-left of the page.

signature_image_w

float

The Width of the Rectangle region of the signature image. This starts from the top-left of the page.

signature_image_h

float

The Height of the Rectangle region of the signature image. This starts from the top-left of the page.

Parámetros opcionales del cuerpo de la solicitud

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

Cabeceras opcionales

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

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

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

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

Parámetros obligatorios del cuerpo de la solicitud

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to encrypt.

Parámetros opcionales del cuerpo de la solicitud

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.

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

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

Descripción: Añade una capa de seguridad a un documento PDF encriptándolo con una contraseña de usuario y de 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
pdf_file	archivo application/pdf	El archivo PDF a encriptar.
allow_extracting_content	bool	Permitir la extracción de contenido del archivo PDF.
allow_form_filling	bool	Permitir el llenado de formularios en el PDF resultante.
allow_annotations	bool	Permitir la adición o modificación de anotaciones en el PDF resultante.
allow_printing	bool	Permitir la impresión del PDF resultante.
allow_modifications	bool	Permitir modificaciones en el PDF resultante.
new_owner_password	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

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
new_user_password	string	null	New user password for the output PDF. Grants read access and other specified permissions.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

Cabeceras opcionales

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

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 texto incrustado en las páginas de un documento. Incluya un archivo PDF como un objeto pdf_file en el cuerpo de la solicitud.

Parámetros obligatorios del cuerpo de la solicitud

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to encrypt.

Parámetros opcionales del cuerpo de la solicitud

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.

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

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

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

Parámetros obligatorios del cuerpo de la solicitud

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file.
user_password	string	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	Owner password for the input PDF.

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.