...
Detalhamento Funcional - FS008375(AAAKH4)
Processos
Expandir |
---|
title | Parâmetros para Integração com TOTVS Sign |
---|
|
Pré-requisitos
Customização instalada e todos os scripts gerados com sucesso.
Detalhamento do Processo
Para a utilização da Customização "Integração com TOTVS Sign" será necessário primeiramente realizar algumas parametrizações. A interface de Parâmetros está disponível em: TOTVS Educacional | TOTVS Sign | Parâmetros TOTVS Sign.

A interface exibirá duas abas para serem configurados, sendo eles:
Aba Identificação: - URL API Assinatura: Campo para informação do endereço da API para onde os documentos serão enviados para serem assinados.
- Endpoint para envio de dados: Identificação do endpoint responsável pelo recebimento dos dados dos arquivos a serem assinados.
- Endpoint para consulta de dados: Identificação do endpoint responsável pela consulta dos dados dos arquivos enviados e retorno dos status das assinaturas.
- Consultar documentos pendentes e atualizar status dos documentos ao abrir visão de monitoramento: Após o documento ser enviado para o portal de assinaturas será possível acompanhar se o mesmo já foi assinado ou não através de uma visão de monitoramento. Ao marcar esse campo quando a visão for aberta, a customização identificará os documentos que estiverem como pendentes de assinatura e realizará uma consulta na API de assinatura para identificar se os mesmos foram assinados e atualizar o status apresentado na tela caso tenham sofrido alterações de status (se foram assinados ou rejeitados).
- Ao abrir visão mostrar apenas dados solicitados pelo usuário logado: Caso seja marcado esse parâmetro apenas documentos enviados por processos solicitados pelo usuário logado, serão exibidos na tela, não sendo possível consultar o status de documentos solicitados por outros usuários.
- Assinar documento ao enviá-lo: Caso marcado, indica que o documento será assinado pelo usuário da inclusão dos documentos assim que os documentos forem incluídos para assinatura.
- Testar conexão API: Funcionalidade utilizada pra testar a conexão com os serviços do portal de assinaturas.

Aba API Totvs Sing User:
- Utilizar token (API Totvs Sing User) para execução de assinatura: Identificador para utilização de um token fixo ou utilização de API para obtenção do Token de autenticação.
- Token Fixo: Caso o campo “Utiliza API Token para execução de assinatura” esteja desmarcado, esse campo ficará habilitado para ser preenchido com o token de autenticação.
- Url API Token: Informe a Url da API responsável pela autenticação do usuário e geração do Token para envio dos documentos.
- Endpoint para obtenção do Token: Identificação do endpoint responsável pela geração do token.
- Utilizar único usuário para geração do Token: define um usuário padrão para geração do token de acesso. Caso não seja definido, será solicitado no momento da integração dos documentos.
- Usuário Token: Informe o usuário para autenticação na Api Token.
- Senha Token: Informe a senha do usuário na Api Token.
- Consultar e criar usuário na API TOTVS Sign User caso não exista: Se desmarcado, caso o usuário não exista no portal, ocorrerá erro no momento da integração dos documentos.
- Endpoint para criação de usuário: Texto com a identificação do Endpoint responsável pelo recebimento dos dados dos usuários a serem criados no TOTVS Sign.
- Endpointo para consulta de usuário: Texto com a identificação do endpoint responsável pela consulta de usuário no TOTVS Sign a fim de identificar a existência do mesmo.
- Testar conexão Sign: Funcionalidade utilizada pra testar a conexão com o portal de assinaturas.

Aviso |
---|
| A permissão de acesso ao menu será feita através de configuração de controle de perfil de usuário (nativa). |
|
...