Referencia de endpoints de la Sign API

Esta página documenta todos los endpoints de la Sign API. Para información sobre autenticación y el formato de respuesta, consulta la visión general de la Sign API.

Certificados

Listar certificados disponibles

Devuelve la lista de certificados a los que el usuario autenticado tiene acceso.

GET /signapi/v1/certificate/list

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Body	—

Respuesta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": [
    {
      "id": 0,
      "alias": "string",
      "thumbprint": "string",
      "pinPolicy": "NoPIN",
      "requireUsageReason": true
    }
  ]
}

Firma

Firmar un documento

Firma un documento y devuelve el archivo firmado.

POST /signapi/v1/sign/document

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Content-Type	multipart/form-data
Respuesta	Archivo firmado

Esta solicitud usa multipart/form-data con dos campos:

• jsonUploadData: Campo de formulario que contiene el JSON serializado (ver ejemplo).
• file: El documento a firmar.

{
  "certificateId": 11,
  "pin": null,
  "reason": null,
  "visualSignature": {
    "x": 316,
    "y": 843,
    "width": 385,
    "height": 96,
    "imageBase64": "[IMAGE_IN_B64]",
    "pages": [1]
  }
}

El campo visualSignature es opcional.

Firmar un hash

Firma un hash de datos y devuelve la firma resultante.

POST /signapi/v1/sign/hash

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Content-Type	application/json

Body

{
  "dataInBase64": "string",
  "hashAlgorithm": "SHA256",
  "padding": "PKCS1",
  "certificate": "string",
  "pin": "string",
  "usageReason": "string"
}

Campo	Tipo	Descripción
dataInBase64	string	Datos a firmar codificados en Base64.
hashAlgorithm	string	Algoritmo de hash. Valores válidos: MD5, SHA1, SHA224, SHA256, SHA384, SHA512.
padding	string	Tipo de padding. Valores válidos: PKCS1, PSS, OAEP.
certificate	string	Thumbprint del certificado a usar.
pin	string	PIN del certificado, si se requiere.
usageReason	string	Motivo de uso, si el certificado lo requiere.

Respuesta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": "string"
}

El campo data contiene la firma resultante codificada en Base64.

Perfil de firma

Los endpoints de perfil permiten gestionar la configuración de firma por defecto del usuario: el certificado preseleccionado, si se incluye una imagen de firma o texto informativo, y en qué páginas se aplica. Esta configuración se usa en el flujo de firma de Signtrust.

info

Estos endpoints están disponibles desde la versión 4.42.0 y requieren un token de acceso obtenido mediante el flujo OAuth2 centralizado.

Obtener el perfil de firma

Devuelve la configuración de firma guardada para el usuario autenticado.

GET /signapi/v1/profile

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Body	—

Respuesta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {
    "hasSelectedCert": true,
    "selectedCertId": 0,
    "includeImage": true,
    "includeInfo": true,
    "infoItems": ["CERTIFICATE"],
    "pageType": "ALL",
    "pageRange": "string"
  }
}

Campo	Tipo	Descripción
hasSelectedCert	boolean	Indica si el usuario tiene un certificado preseleccionado.
selectedCertId	integer | null	ID del certificado preseleccionado. Solo presente si hasSelectedCert es true.
includeImage	boolean	Indica si se incluye una imagen de firma personalizada.
includeInfo	boolean	Indica si se incluye información textual en la firma visual.
infoItems	array	Lista de elementos informativos incluidos. Valores válidos: CERTIFICATE, FRIENDLYNAME, DATE, THUMBPRINT.
pageType	string	Páginas donde se aplica la firma. Valores válidos: CURRENT, LAST, ALL, RANGE.
pageRange	string | null	Rango de páginas en formato 1-3,5. Solo presente si pageType es RANGE.

Guardar el perfil de firma

Crea o reemplaza la configuración de firma del usuario autenticado.

POST /signapi/v1/profile

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Content-Type	application/json

Body

{
  "hasSelectedCert": true,
  "selectedCertId": 0,
  "includeImage": true,
  "includeInfo": true,
  "infoItems": ["CERTIFICATE"],
  "pageType": "ALL",
  "pageRange": null
}

Campo	Tipo	Requerido	Descripción
hasSelectedCert	boolean	Sí	Indica si se preselecciona un certificado.
selectedCertId	integer | null	Condicional	Requerido si hasSelectedCert es true.
includeImage	boolean	Sí	Indica si se incluye imagen de firma.
includeInfo	boolean	Sí	Indica si se incluye información textual.
infoItems	array	Condicional	Requerido si includeInfo es true. Debe contener al menos un elemento. Valores válidos: CERTIFICATE, FRIENDLYNAME, DATE, THUMBPRINT.
pageType	string	Sí	Páginas donde se aplica la firma. Valores válidos: CURRENT, LAST, ALL, RANGE.
pageRange	string | null	Condicional	Requerido si pageType es RANGE. Formato: 1-3,5.

Respuesta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {}
}

Eliminar el perfil de firma

Elimina la configuración de firma guardada del usuario autenticado.

DELETE /signapi/v1/profile

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Body	—

Respuesta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {}
}

Imagen de firma

Estos endpoints permiten gestionar la imagen personalizada que se superpone en el documento al firmar (la representación visual de la firma).

info

Estos endpoints están disponibles desde la versión 4.42.0 y requieren un token de acceso obtenido mediante el flujo OAuth2 centralizado.

Obtener la imagen de firma

Devuelve la imagen de firma del usuario autenticado.

GET /signapi/v1/profile/image

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Body	—

Respuesta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {
    "imageInBase64": "string"
  }
}

Subir la imagen de firma

Sube o reemplaza la imagen de firma del usuario autenticado.

PUT /signapi/v1/profile/image

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Content-Type	application/json

Body

{
  "imageInBase64": "string"
}

El campo imageInBase64 debe contener la imagen codificada en Base64.

Respuesta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {}
}

Eliminar la imagen de firma

Elimina la imagen de firma del usuario autenticado.

DELETE /signapi/v1/profile/image

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Body	—

Respuesta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {}
}

Configuración de SharePoint

Obtener la configuración de SharePoint

Devuelve los parámetros de configuración de SharePoint asociados a la instalación de Redtrust. Estos valores se usan para la integración de Signtrust con SharePoint.

GET /signapi/v1/sp-config

info

Este endpoint está disponible desde la versión 4.42.0 y requiere un token de acceso obtenido mediante el flujo OAuth2 centralizado.

Parámetro	Valor
Autenticación	Authorization: Bearer TU_ACCESS_TOKEN
Body	—

Respuesta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {
    "sharepoint_clientid": "string",
    "sharepoint_tenantid": "string"
  }
}

Campo	Descripción
sharepoint_clientid	ID de cliente de la aplicación registrada en Azure para la integración con SharePoint.
sharepoint_tenantid	ID del tenant de Azure asociado a la organización.