Descripción del alcance de las interfaces de la aplicación del ecosistema ISV

1. Resumen

Este documento tiene como objetivo proporcionar una descripción de los ámbitos de permisos (Scope) en el sistema de autorización de aplicaciones de eSignGlobal para los desarrolladores de socios del ecosistema. Al integrar la autorización de aplicaciones, los desarrolladores deberán solicitar el Scope correspondiente según las necesidades reales de sus funciones comerciales. Cada Scope incluye la lista de OpenAPIs permitidas dentro de dicho ámbito de permisos, y la plataforma controlará estrictamente los permisos de operación de la aplicación sobre los recursos relacionados en función del Scope autorizado.

Interfaz de autenticación básica

Antes de que las aplicaciones del ecosistema puedan llamar a las interfaces oficialmente, primero deben obtener las credenciales de llamada a través del endpoint de autorización:

Nombre de la interfaz	Ruta de la interfaz	Descripción de la interfaz
Obtener AccessToken	`POST /esignglobal/v1/oauth2/accessToken`	A través de appid y appsecret para obtener el access_token de autenticación, utilizado para solicitar la API de eSignGlobal en nombre de un usuario específico. El Token es válido durante 24 horas.

Actualmente, los ámbitos de permisos (Scope) abiertos en el ecosistema de eSignGlobal incluyen principalmente:

signature: Servicio central de firma electrónica
stamp: Servicio de gestión de sellos
comparisons: Servicio de comparación de contratos

2. Detalles del Scope y lista de interfaces

2.1 Scope: `signature` (Servicio de firma electrónica)

Este Scope es el ámbito de permisos más básico y utilizado, que incluye las interfaces principales de extremo a extremo para los servicios de firma electrónica. Tras autorizar este Scope, la aplicación podrá gestionar y ejecutar flujos de trabajo sobre plantillas, documentos de firma (con archivos adjuntos), participantes y el flujo principal de sobres.

Módulo 1: Servicio de plantillas

Nombre de la interfaz	Descripción de la interfaz
Obtener detalles de los controles de plantilla del firmante	Obtener información de los controles de plantilla del firmante indicado y su configuración de atributos correspondiente
Obtener detalles de la plantilla	Obtener la información completa de una plantilla específica, que incluye los detalles de los campos y la estructura del archivo
Completar plantilla para generar archivo	Rellenar los datos empresariales según la plantilla indicada y generar automáticamente un archivo en formato PDF
Consultar lista de plantillas	Consultar la lista de plantillas disponibles en la cuenta actual mediante paginación o filtros específicos
Consultar detalles de la tarea de generación de archivos	Consultar el resultado final de la ejecución de la tarea de generación de archivos por plantilla a través del ID de tarea asíncrona

Módulo 2: Gestión de archivos

Nombre de la interfaz	Descripción de la interfaz
Subir archivo	Subir archivos locales o archivos de flujo de negocio especificados a la plataforma para su uso en firmas posteriores
Obtener coordenadas según palabras clave	Realizar una búsqueda de texto en los documentos cargados y devolver la información de las coordenadas de ubicación de las palabras clave coincidentes
Descargar archivo	Descargar documentos firmados específicos, archivos fuente u otros archivos adjuntos de negocio
Agregar archivo de firma	Vincular los archivos subidos previamente con éxito a un sobre de firma o proceso específico
Eliminar archivo de firma	Eliminar del flujo del sobre los archivos subidos por error o que no requieren firma temporalmente
Agregar adjunto	Agregar archivos adjuntos explicativos complementarios al proceso del sobre o de firma
Eliminar archivo adjunto	Eliminar los documentos adjuntos especificados del proceso del sobre o de firma

Módulo tres: Gestión de participantes

Nombre de la interfaz	Descripción de la interfaz
Agregar firmante	Agregar un participante firmante que deba ejecutar la acción de firma en un proceso de sobre específico
Eliminar firmante	Eliminar una parte firmante dada de baja de un proceso de sobre específico
Agregar destinatario en copia	Agregar rol de copia, solo recibe notificaciones de progreso y visualiza el documento firmado finalizado
Eliminar destinatario en copia	Eliminar rol de copia específico

Módulo cuatro: Gestión de sobres

Nombre de la interfaz	Descripción de la interfaz
Iniciar sobre rápidamente	Si la plataforma integrada utiliza esta interfaz para crear un sobre y, una vez completada la firma, el sistema gestiona automáticamente el proceso de finalización, no es necesario invocar manualmente «Finalizar sobre».
Crear sobre	Se utiliza para crear un sobre en estado de borrador; permite configurar parámetros como el asunto de la firma, la configuración del firmante, etc.
Enviar sobre	Tras confirmar que todos los documentos y firmantes son correctos, se envía formalmente la tarea de firma al siguiente paso del flujo.
Finalizar sobre	Finalizar el sobre manualmente. Antes de finalizarlo, todos los firmantes deben completar su firma; una vez terminado el proceso, los recursos ya no podrán modificarse.
Obtener enlace de firma	Obtén el enlace corto exclusivo o la URL de la página de firma directamente accesible para el firmante indicado.
Consultar detalles del sobre	Obtiene la información general del sobre, los archivos asociados, los participantes y el estado actual del flujo.
Revocar sobre	Retirada activa por parte del iniciador de un sobre de firma que aún no se ha completado en su totalidad
Sobre de recordatorio de firma	Cuando el sobre no esté completamente firmado, permite enviar recordatorios a los firmantes pendientes, con un intervalo de recordatorio de 30 minutos.
Obtener la dirección de la página de vista previa de firma	Una vez abierto el sobre, se puede utilizar esta interfaz para obtener la dirección de la página de vista previa de firma. Se utiliza principalmente dentro de la plataforma integrada para permitir que usuarios ajenos al sobre visualicen los documentos y el estado del proceso.
Crear vista de envío de sobre	Crear la vista del remitente del sobre mediante el ID del sobre. En los flujos de firma iniciados desde esta vista, la información del iniciador se rellenará con los datos de usuario extraídos del Access Token de OAuth.

2.2 Scope: `stamp` (Servicio de gestión de sellos)

Este Scope está diseñado específicamente para la autorización de gestión de sellos corporativos o nombres personales. Es adecuado para ecosistemas de terceros que solo necesiten mantener una base de datos unificada de sellos corporativos (CRUD de sellos), sin intervenir directamente en el flujo de inicio de firmas.

Nombre de la interfaz	Descripción de la interfaz
Consultar lista de sellos	Utilizar un AppID con permisos de consulta de sellos correspondientes para obtener los datos de la lista de recursos de sellos.
Crear sello	Utilizar un AppID con permisos para crear un sello mediante una cadena codificada en Base64 de la imagen subida (formato PNG admitido, tamaño de 18 mm a 100 mm).
Editar sello	Modificar información como el nombre y la imagen de los sellos ya creados
Eliminar sello	Eliminar por completo los recursos de sello especificados que ya no mantienen ninguna relación comercial

2.3 Scope: `comparisons` (Servicio de comparación de contratos)

Este Scope está dedicado exclusivamente al ámbito funcional de legalidad de contratos inteligentes. Permite que las aplicaciones de socios del ecosistema invoquen de forma flexible las capacidades de comparación de texto y versiones en sus propios procesos de revisión contractual y evaluación legal, para identificar rápidamente las diferencias antes y después de las revisiones de los contratos.

Nombre de la interfaz	Descripción de la interfaz
Obtener la página de resultados de la comparación de contratos	Obtener la dirección de la página de visualización que muestra los resultados de las diferencias comparadas
Consultar los detalles de la comparación de contratos	Obtener el resultado de la comparación del contrato mediante el ID de negocio de comparación de contratos, que incluye la cantidad de diferencias (número de adiciones, eliminaciones y modificaciones) así como el contenido detallado de las diferencias comparadas (localización de los detalles).