Configurar spoke DocuSign usando concessão JWT

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 9 min. de leitura

    • Integre a instância [ ServiceNow e DocuSign usando a concessão JWT para autenticar solicitações ServiceNow.

    Antes de Iniciar

    • Solicitar uma assinatura de IntegrationHub.
    • Ative o DocuSign.
    • Função necessária: administrador
    Importante:
    Se você estiver configurando o spoke DocuSign usando a concessão JWT, não será necessário configurar o spoke usando a concessão de código de autorização.

    Configurar conta do DocuSign

    Crie uma aplicação OAuth personalizada de sua conta do DocuSign para habilitar a autenticação OAuth 2.0 com o Spoke do DocuSign eSignature.

    Antes de Iniciar

    Requisitos do DocuSign:
    • Conta do DocuSign
    • Aplicação DocuSign configurada para integração com ServiceNow
    • Função necessária: administrador do DocuSign

    Por Que e Quando Desempenhar Esta Tarefa

    Conclua essas etapas na sua conta do DocuSign. Consulte a documentação do DocuSign Developer Center para obter instruções sobre como criar e configurar aplicações personalizadas. O DocuSign usa um webhook com script para enviar dados do documento assinado para a instância ServiceNow. Isso permite que os designers de fluxo pausem um fluxo até que um documento seja assinado e usem os dados do documento no fluxo.

    Procedimento

    1. Na sua conta do DocuSign, registre sua aplicação.
    2. Gere uma chave de integrador e uma chave secreta.
    3. Registre os valores da chave do integrador e da chave secreta para registrar o app como um provedor OAuth de terceiros em sua instância ServiceNow.
      Você precisará desses valores ao Registrar DocuSign como provedor OAuth
    4. Clique em ADICIONAR RSA KEYPAIR e registre o IDdo par de chaves, a chave públicae a chave privada.
    5. Adicione o URL de redirecionamento do OAuth ServiceNow em sua conta do DocuSign.
      1. Navegar até Integrações > App e chaves.
      2. Em Aplicativos e chaves de integração, encontre o app necessário.
      3. Para o app necessário, clique na lista suspensa Ações e clique em Editar.
      4. Em Configurações adicionais, clique em Adicionar URI e adicione o endpoint de retorno de chamada OAuth neste formato: https://<instance> .service-now.com/oauth_redirect.do .
        Adicione o URI de redirecionamento na conta do DocuSign.
    6. Obtenha o valor do URI base da conta da conta do DocuSign.
      1. Navegar até Integrações > App e chaves.
      2. Em Informações da minha conta, você pode encontrar o valor do URI base da conta.
        URI base da conta.
      3. Copie e registre este valor para uso posterior.

    Gerar o certificado JKS

    Gere um certificado JKS para a autenticação JWT do Spoke do DocuSign eSignature.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Abra o editor de texto para código como Sublime Text.
    2. Crie um novo arquivo.
    3. Cole a chave privada que você gerou anteriormente a partir do aplicativo integrador DocuSign.
      Para obter mais informações, consulte Configurar conta do DocuSign.
      Nota:
      Certifique-se de incluir o início e o fim da chave privada.
    4. Salve o arquivo com a extensão .key, por exemplo, privatekey.key.
    5. Abra o terminal e navegue até o diretório em que você salvou o arquivo com a extensão .key.
    6. Crie um certificado assinado por CA usando sua chave privada executando o comando: 
      openssl req -new -x509 -key <file-name>.key -out <certificate-name>.pem -days 1095
      O sistema solicita que você forneça os detalhes necessários, como Nome do país, Nome da província e assim por diante.
    7. Insira os detalhes necessários.
    8. Crie o arquivo PKCS 12 usando sua chave privada e o certificado assinado por CA executando o comando: 
      openssl pkcs12 -export -in <certificate-name>.pem -inkey <file-name>.key -certfile <certificate-name>.pem -out <PKCS-12-file-name>.p12
      O sistema solicita que você forneça uma senha.
    9. Forneça a senha de exportação.
    10. Crie o arquivo JKS executando este comando: 
      keytool -importkeystore -srckeystore <PKCS-12-file-name>.p12 -srcstoretype pkcs12 -destkeystore <JKS-certificate-filename>.jks -deststoretype JKS
      O sistema solicita que você forneça uma senha.
    11. Forneça as senhas do armazenamento de chaves de destino e de origem.

    Anexar um certificado Java Key Store ao Spoke do DocuSign eSignature

    Habilite a autenticação de token de Concessão do Portador JWT anexando um certificado Java KeyStore (JKS) válido ao Spoke do DocuSign eSignature.

    Antes de Iniciar

    • Garantir a disponibilidade de um certificado Java KeyStore válido
    • Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Definição do Sistema > Certificados.
    2. Clique em Nova.
    3. Preencha o formulário.
      Tabela 1. Campos do formulário da certificação X.509
      Campo Descrição
      Nome Insira um nome para identificar exclusivamente o registro. Por exemplo, Certificado DocuSign.
      Notificar no vencimento Defina usuários a serem notificados quando o certificado expirar.
      Aviso emitido antes do vencimento (em dias) Insira o número de dias para enviar uma notificação antes que o certificado expire.
      Ativo Habilitar
      Tipo Selecione Armazenamento de chaves Java.
      Dias até o vencimento Insira o número de dias até o certificado expirar.
      Senha do armazenamento de chaves Insira uma senha associada ao certificado.
      Descrição resumida Insira um resumo sobre o certificado.
    4. Clique no ícone de anexos (ícone de anexos) e anexe um certificado JKS.
    5. Clique em Validar armazenamentos/certificados.

    Criar uma chave de assinatura JWT para o Spoke do DocuSign eSignature

    Crie uma chave de assinatura JSON Web Token (JWT) para atribuir ao seu certificado Java KeyStore.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > OAuth de Sistema > Chaves de JWT.
    2. Clique em Nova.
    3. Preencha o formulário.
      Tabela 2. Campos do formulário de chaves de JWT
      Campo Descrição
      Nome Insira um nome para identificar exclusivamente a chave de assinatura JWT. Por exemplo, Chaves DocuSign JWT.
      Armazenamento de chaves de assinatura Selecione o certificado JKS válido anexado na tarefa anterior. Por exemplo, Certificado DocuSign.
      ID de chave Insira um ID de chave para identificar qual chave é usada quando várias chaves são usadas para assinar tokens.
      Algoritmo de assinatura Selecione um algoritmo para assinar com a chave JWT.
      Senha da chave de assinatura Insira uma senha associada à chave de assinatura.
      Ativo Habilitar.
    4. Clique em Enviar.

    Criar um provedor JWT para o Spoke do DocuSign eSignature

    Adicione um provedor JSON Web Token (JWT) à sua instância da ServiceNow.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > OAuth de Sistema > Provedores JWT.
    2. Clique em Nova.
    3. No formulário, preencha os campos.
      Tabela 3. Campos de formulário do Provedor JWT
      Campo Descrição
      Nome Insira um nomepara identificar exclusivamente o provedor JWT. Por exemplo, Provedor DocuSign JWT.
      Intervalo de vencimento (s) Insira um número em segundos para definir o lifespan de provedor JWT tokens.
      Configuração de Assinatura Selecione uma chave de assinatura JWT . Por exemplo, Chaves DocuSign JWT.
    4. Clique com o botão direito no cabeçalho do formulário e clique em Salvar.
      As listas relacionadas a Declarações padrão e Declarações personalizadas são exibidas.
    5. Selecione o provedor JWT criado para o spoke do DocuSign.
    6. Insira valores para iss, sube aud na lista relacionada Declarações padrão.
      Consulte o DocuSign Developer Center para obter instruções.
    7. Insira um registro na lista relacionada Declarações personalizadas e preencha o formulário.
      Tabela 4. Campos da lista relacionada de declarações personalizadas
      Campo valor
      Nome da declaração escopo
      Tipo de Valor de Declaração cadeia de caracteres
      Valor da declaração representação de assinatura
    8. Clique em Atualizar.

    Registrar DocuSign como provedor OAuth

    Use as informações geradas durante a configuração da conta do DocuSign para registrar o DocuSign como um provedor OAuth e permitir que a instância solicite tokens OAuth 2.0.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > OAuth de Sistema > Registro de aplicações.
    2. Clique em Nova.
      O sistema exibe a mensagem Que tipo de aplicação OAuth?
    3. Selecione Conectar a um provedor OAuth de terceiros.
      O sistema exibe um formulário de Registros de aplicações em branco.
    4. Preencha o formulário.
      Campo Valor necessário
      Nome Insira qualquer nome para identificar exclusivamente o registro. Por exemplo, insira DocuSign OAuth.
      ID de cliente Insira a chave do integrador que você gerou durante a configuração da conta do DocuSign.
      Segredo do cliente Insira o segredo do cliente que você gerou durante a configuração da conta do DocuSign.
      Tipo de concessão padrão Selecione Portador JWT.
      URL de Autorização
      • Para o ambiente de área restrita do desenvolvedor, insira https://account-d.docusign.com/oauth/auth.
      • Para o sistema de produção em tempo real, insira https://account.docusign.com/oauth/auth.
      URL do token
    5. Clique com o botão direito no cabeçalho do formulário e clique em Salvar.
      • O sistema valida as credenciais do OAuth e preenche o URL de redirecionamento.
      • O sistema preenche o perfil de entidade OAuth com o tipo de concessão como portador JWT. Por exemplo, o perfil de entidade OAuth é criado com o nomepadrão DocuSign OAuth default_profile
    6. Insira um registro na lista relacionada Escopos de entidade OAuth e preencha os valores.
      Tabela 5. Campos da lista relacionada de escopos de entidade OAuth
      Campo Valor
      Nome escopo
      Escopo do OAuth representação de assinatura
    7. Copie o valor de URL de redirecionamento.
    8. Clique em Atualizar.
    9. Faça login na sua conta do DocuSign para editar a configuração da aplicação DocuSign personalizada.
      Consulte o DocuSign Developer Center para obter instruções.
    10. Cole o valor do URL de redirecionamento no URI de redirecionamento da aplicação DocuSign personalizada.
      Por exemplo, cole https://instance.service-now.com/oauth_redirect.do

    Resultado

    A instância pode solicitar tokens OAuth 2.0 para o spoke.
    Nota:
    Quando um token OAuth expira, o spoke gera automaticamente um novo token na maioria dos casos. Se um token expirar e não for gerado novamente, um administrador poderá gerar novamente o token OAuth do spoke.

    Criar registros de credenciais para o Spoke do DocuSign eSignature

    Crie registros de credencial para a aplicação OAuth personalizada do DocuSign que você criou durante a configuração da conta do DocuSign. Os aliases de conexão e credencial do spoke do DocuSign usam essas credenciais para autorizar ações.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Conexões e Credenciais > Credenciais.
    2. Clique em Nova.
      O sistema exibe a mensagem Que tipo de credenciais você deseja criar?.
    3. Selecione Credenciais OAuth 2.0.
      A janela pop-up exibe um formulário de Credenciais do OAuth 2.0 em branco.
    4. Preencha estes valores.
      Campo Valor necessário
      Nome Insira qualquer nome para identificar exclusivamente o registro. Por exemplo, insira Credenciais do DocuSign.
      Ativo Habilitar
      Perfil de Entidade OAuth Selecione o perfil OAuth que você criou ao registrar a aplicação DocuSign personalizada como um provedor OAuth. Por exemplo, selecione DocuSign OAuth default_profile.
      Aplica-se a Selecione os MID Servers que podem usar esta credencial. Por exemplo, selecione Todos os MID Servers.
      Ordem Selecione a ordem para aplicar esta credencial. Por exemplo, insira 100.
    5. Salve o registro.
    6. Clique no link relacionado Obter token OAuth para gerar o token OAuth.

    Criar registros de conexão para o Spoke do DocuSign eSignature

    Crie registros de conexão para sua conta do DocuSign. Os aliases de conexão e credencial do spoke do DocuSign usam essas credenciais para executar ações em DocuSign.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Conexões e Credenciais > Aliases de conexão e credencial.
    2. Aberto para o registro do DocuSign.
    3. Na guia Conexões, clique em Novo.
      O sistema exibe um formulário de conexão HTTP(s) em branco.
    4. Insira estes valores.
      Campo Valor necessário
      Nome Insira qualquer nome para identificar exclusivamente o registro da conexão. Por exemplo, insira Conexão do DocuSign.
      Credencial Selecione o registro de credencial que você criou para o DocuSign. Por exemplo, selecione Credenciais do DocuSign.
      URL de conexão
      • Para o ambiente de demonstração, insira https://demo.docusign.net.
      • Para o sistema de produção dinâmico, insira o URI base, como na2.docusign.net ou eu.docusign.net. Para obter instruções sobre como obter o URI base, consulte Referência de endpointde pós-lançamento e informações do usuário na documentação do DocuSign Developer Center.
    5. Clique em Enviar.

    O que Fazer Depois

    Sincronize o ServiceNow com o DocuSign para acessar contas e modelos DocuSign e envelopes do DocuSign spoke. Consulte Sincronizar DocuSign com a ServiceNow.