Descrição do Escopo das Interfaces de Aplicações do Ecossistema ISV

1. Visão Geral

Este documento visa fornecer uma descrição dos Scopes (domínios de permissão) no sistema de autorização de aplicativos da eSignGlobal para desenvolvedores parceiros do ecossistema. Ao realizar a integração de autorização do aplicativo, os desenvolvedores devem solicitar o Scope correspondente conforme as necessidades reais das funcionalidades de negócio. Cada Scope inclui a lista de OpenAPIs permitidas para chamadas nesse domínio de permissão, e a plataforma controlará rigorosamente as permissões de operação do aplicativo sobre os recursos relacionados com base nos Scopes autorizados.

Interface de Autenticação Básica

Antes que os aplicativos do ecossistema chamem oficialmente as interfaces, é necessário primeiro obter as credenciais de chamada por meio do ponto de autorização:

Nome da Interface	Caminho da Interface	Descrição da Interface
Obter AccessToken	`POST /esignglobal/v1/oauth2/accessToken`	Através do appid e appsecret para obter o access_token de autenticação, usado para solicitar a API eSignGlobal na identidade de um usuário específico. O tempo de validade do Token é de 24 horas.

Atualmente, os domínios de permissão Scope abertos no ecossistema eSignGlobal incluem principalmente:

signature: Serviço Central de Assinatura Eletrônica
stamp: Serviço de Gerenciamento de Carimbos
comparisons: Serviço de Comparação de Contratos

2. Detalhes do Scope e Lista de APIs

2.1 Scope: `signature` (Serviço de Assinatura Eletrônica)

Este Scope é o domínio de permissão mais básico e amplamente utilizado, contendo as APIs centrais de ponta a ponta para o negócio de assinatura eletrônica. Após autorizar este Scope, a aplicação poderá gerir e executar operações de fluxo nos modelos, documentos de assinatura (incluindo anexos), participantes e no processo principal de envelopes.

Módulo 1: Serviço de Modelos

Nome da API	Descrição da API
Obter detalhes dos controles do modelo do signatário	Obter informações dos controles do modelo do signatário especificado e suas respectivas configurações de atributos
Obter detalhes do modelo	Obter informações completas de um modelo específico, incluindo detalhes dos campos e da estrutura do arquivo
Preencher modelo para gerar arquivo	Com base no modelo fornecido, preencher os dados de negócio e gerar automaticamente um arquivo em formato PDF
Consultar lista de modelos	Consultar a lista de modelos disponíveis na conta atual com paginação ou conforme critérios de filtro específicos
Consultar detalhes da tarefa de geração de arquivo	Consultar o resultado final da execução da tarefa de geração de arquivos por modelo usando o ID da tarefa assíncrona

Módulo 2: Gestão de Arquivos

Nome da Interface	Descrição da Interface
Carregar Arquivo	Carregar arquivos locais ou arquivos de fluxo de negócios especificados para a plataforma, para uso posterior na assinatura
Obter coordenadas com base em palavras-chave	Realizar pesquisa de texto nos documentos carregados e retornar as informações de coordenadas das posições das palavras-chave correspondentes
Baixar Arquivo	Baixar documentos assinados concluídos específicos, arquivos originais ou outros arquivos anexos de negócios
Adicionar arquivo de assinatura	Vincular os arquivos carregados com sucesso anteriormente a um envelope de assinatura ou processo específico
Excluir arquivo de assinatura	Remover do fluxo do envelope os arquivos enviados por engano ou que não precisam ser assinados no momento
Adicionar anexo	Adicionar anexos explicativos de natureza suplementar ao fluxo do envelope ou de assinatura
Remover anexo	Remover documentos de anexo especificados do fluxo do envelope ou de assinatura

Módulo 3: Gestão de Participantes

Nome da interface	Descrição da interface
Adicionar signatário	Adicionar um participante de assinatura que deve executar a ação de assinatura em um fluxo de envelope específico
Remover signatário	Remover uma parte signatária obsoleta de um fluxo de envelope específico
Adicionar destinatário de cópia	Adicionar papel de destinatário de cópia, que recebe apenas notificações de progresso e visualiza o documento final assinado
Remover destinatário de cópia	Remover papel específico de destinatário de cópia

Módulo 4: Gestão de Envelopes

Nome da interface	Descrição da interface
Criar envelope rapidamente	Se a plataforma integrada usar esta interface para criar um envelope e, após a conclusão da assinatura, o sistema processar automaticamente o encerramento do fluxo, não será necessário chamar manualmente o 'Encerrar envelope'.
Criar envelope	Usado para criar envelopes em estado de rascunho, suportando a configuração de parâmetros como o assunto da assinatura e as configurações dos signatários.
Ativar envelope	Após confirmar que todos os documentos de assinatura e os signatários estão corretos, envie oficialmente a tarefa de assinatura para o próximo estágio.
Encerrar envelope	Encerramento manual do envelope. Antes do encerramento, todos os signatários devem concluir a assinatura; após o término do fluxo, os recursos não podem ser modificados.
Obter endereço de assinatura	Obter o link curto exclusivo ou a URL da página de assinatura diretamente carregável para o signatário especificado.
Consultar detalhes do envelope	Obter informações gerais do envelope, arquivos associados, participantes e o status atual do fluxo.
Cancelar envelope	Retirada proativa de um envelope de assinatura ainda não totalmente concluído pelo iniciador
Lembrete de envelope	Quando o envelope não estiver concluído para assinatura, é possível enviar um lembrete aos signatários que precisam assinar mas ainda não o fizeram, com um intervalo de lembrete de 30 minutos.
Obter endereço da página de visualização da assinatura	Após a abertura do envelope, é possível obter o endereço da página de visualização da assinatura por meio desta interface. Utilizado principalmente na plataforma integrada para permitir que usuários não participantes do envelope visualizem os documentos de assinatura e o progresso.
Criar visualização de envio de envelope	Criar visualização do remetente do envelope por meio do ID do envelope. Nos fluxos de assinatura iniciados nesta visualização, as informações do iniciador serão preenchidas com os dados do usuário extraídos do Access Token do OAuth.

2.2 Scope: `stamp` (Serviço de Gerenciamento de Carimbos)

Este Scope destina-se especificamente à autorização de gerenciamento de carimbos empresariais ou carimbos pessoais. É adequado para ecossistemas de terceiros que necessitam apenas manter uma biblioteca unificada de carimbos empresariais (adição, remoção, atualização e consulta de carimbos), sem necessidade de intervir diretamente no fluxo de iniciação de assinaturas.

Nome da interface	Descrição da interface
Consultar lista de carimbos	Utilize um AppID com permissão de consulta correspondente para obter os dados da lista de recursos de carimbos.
Criar carimbo	Utilize um AppID com permissão para criar um carimbo por meio de uma string codificada em Base64 da imagem enviada (suporta PNG, tamanho de 18 mm a 100 mm).
Editar carimbo	Modificar informações como nome e imagem de um carimbo já criado
Excluir carimbo	Remover permanentemente os recursos de carimbo especificados que não possuem mais vínculo comercial

2.3 Scope: `comparisons` (Serviço de comparação de contratos)

Este escopo destina-se exclusivamente ao domínio funcional jurídico de contratos inteligentes. Permite que aplicações de parceiros do ecossistema invoquem de maneira flexível a capacidade de comparação de textos e versões durante as etapas de revisão contratual e avaliação jurídica, assegurando um controle ágil das diferenças entre a versão anterior e a revisada do contrato.

Nome da interface	Descrição da interface
Obter a página de resultados da comparação de contratos	Obter o endereço da página visual que apresenta os resultados das diferenças comparadas
Consultar detalhes da comparação de contratos	Obter o resultado da comparação do contrato por meio do ID de negócio da comparação, contendo a quantidade de diferenças (número de adições, exclusões e modificações) e o conteúdo detalhado das diferenças encontradas (localização específica).