Integração com DocuSign

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 7 min. de leitura

    • A integração da aplicação Gestão de ativos de software com o serviço DocuSign permite que você rastreie suas assinaturas de software e recupere licenças não utilizadas.

    DocuSign compras feitas por meio de revendedores não são refletidas no sistema de faturamento padrão DocuSign. Portanto, nenhum valor é retornado por meio das APIs para consumo de envelope que está disponível para ServiceNow.

    Nota:
    DocuSign removeu o campo lastLogin da API Users. Portanto, as últimas atividades dos usuários não são rastreadas como parte desta integração.

    Para obter mais informações sobre o serviço DocuSign, consulte o site do DocuSign Developer.

    Importante:
    Minimize os riscos de segurança e proteja as informações concedendo acesso somente ao usuário ou às permissões de API necessárias.
    Tabela 1. Permissões mínimas do usuário
    Processo Função do usuário necessária na aplicação DocuSign Escopos de autenticação
    Download de assinaturas administrador Sem escopos
    Recuperar assinatura administrador Sem escopos

    Registrar uma aplicação DocuSign

    Registre uma aplicação DocuSign por meio do portal do administrador DocuSign.

    Antes de Iniciar

    DocuSign Função necessária: administrador

    Procedimento

    1. Faça login na sua conta de demonstração DocuSign (não produção).
    2. Selecione sua imagem de perfil.
    3. Selecione Meus apps e chaves.
      • Se você já tiver uma chave de integração de API de uma integração anterior pronta para uso na produção, pule para a etapa 33.
      • Se você não tiver o segredo do cliente salvo, deverá gerar um novo.
    4. No painel esquerdo, selecione INTEGRAÇÕES > Aplicações e chaves.
    5. Na seção Aplicações e chaves de integração, selecione ADICIONAR APLICATIVO E CHAVE DE INTEGRAÇÃO.
    6. No formulário Adicionar chave de integração, forneça um nome no campo Nome da aplicação e selecioneCRIAR APLICATIVO.
    7. Selecione ADICIONAR URI no campo Redirecionar URIs na seção Configurações adicionais.
    8. Adicione https://oauth.pstmn.io/v1/browser-callback.
    9. Selecione ADICIONAR URI novamente e adicione https://ServiceNow instance.service-now.com/oauth_redirect.do.
    10. Selecione ADICIONAR CHAVE SECRETA.
      Salve a chave de integração (ID do cliente) e a chave secreta (segredo do cliente) em um local seguro para usá-las posteriormente no app Postman e a chave de integração (ID do cliente) na instância ServiceNow.
    11. Selecione Save (Salvar).
    12. Baixe a versão mais recente do app Postman e pule o login.
    13. Selecionar Nova coleção e forneça um nome para a coleção.
    14. Selecione a guia Autorização.
    15. No menu de lista Tipo, selecione OAuth 2.0.
    16. Forneça um nome e preencha os campos na guia Opções de configuração para criar um token:
      Campo Valor
      URL do Retorno de Chamada https://oauth.pstmn.io/v1/browser-callback
      URL de autenticação https://account-d.docusign.com/oauth/auth
      URL do Token de Acesso https://account-d.docusign.com/oauth/token
      ID de cliente A chave de integração da sua conta de demonstração DocuSign criada na etapa 10.
      Segredo do cliente A chave secreta da sua DocuSign conta de demonstração etapa 10.
    17. Selecione Obter novo token de acesso.
      Você será redirecionado para DocuSign.
    18. Selecione Aceitar.
    19. Depois que o token de acesso for coletado e a autenticação concluída, copie o token de acesso para usá-lo mais tarde.
    20. Selecione Nova solicitação para criar uma solicitação GET para o ID da sua conta.
    21. Insira o URL no campo GET como https://account-d.docusign.com/oauth/userinfo.
    22. Na guia Cabeçalhos, selecione Autorização em CHAVE e insira Portador<Access Token that you copied during authentication> em Valor .
    23. Selecione Enviar e verifique se a solicitação foi concluída.
      O ID da conta é exibido no corpo da resposta.
    24. Duplique a solicitação GET.
      Copie a chave de autorização e o valor em Cabeçalhos.
    25. Atualize a URL no campo GET como https://demo.docusign.net/restapi/v2/accounts/<account-id> /usuários .
      Aqui, account-id é o ID que você salvou da solicitação anterior.
    26. Selecione Enviar 20 vezes para fazer 20 chamadas de API.
      Você deve invocar um mínimo de 20 chamadas de API para registrar sua aplicação por meio do DocuSign portal do administrador.
    27. Navegue até Aplicações e chaves de integração no DocuSign portal do administrador.
    28. Selecionar Ações > Exibir painel de API ao lado da sua aplicação.
    29. Aguarde alguns minutos até que DocuSign registre todas as 20 chamadas de API.
    30. Navegar até INTEGRAÇÕES > Aplicações e chaves e selecione Enviar para revisão.
      Após 5 a 20 minutos, a revisão da sua aplicação estará concluída. Você pode promover a aplicação para sua conta de produção.
    31. Selecionar Ações > Revisão Start-Go-Live para promover a aplicação para a conta de produção.
    32. Selecione uma conta de produção qualificada para gerenciar a chave de integração.
    33. Faça login na sua conta de conteúdo de produção DocuSign.
    34. Selecione sua imagem de perfil.
    35. Selecione Ir para o administrador.
    36. No painel esquerdo, selecione INTEGRAÇÕES > Aplicações e chaves.
      Localize o ID da conta da API a ser usado para o perfil de integração em sua instância ServiceNow.
    37. Ao lado da sua aplicação, selecione Ações > Editar.
    38. Selecione ADICIONAR URI e adicione https://instância da ServiceNow.service-now.com/oauth_redirect.do.
    39. Selecione ADICIONAR CHAVE SECRETA.
      Salve a chave secreta (segredo do cliente) da sua conta de produção em um local seguro para usá-la na instância ServiceNow.
    40. Selecione Save (Salvar).

    Criação do perfil de Integração DocuSign

    Crie um perfil de integração para rastrear assinaturas de software e otimizar o licenciamento do serviço DocuSign.

    Antes de Iniciar

    Para criar um perfil de integração DocuSign, solicite o plug-in Gestão de ativos de software - Gestão de licenças de SaaS (sn_sam_saas_int) na ServiceNow Store.

    ServiceNow Função necessária: sam_integrator ou administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Se você estiver usando Espaço para ativos de software, a opção para criar o perfil de integração DocuSign em IU principal estará inativa.

    Procedimento

    1. Navegue até o perfil de integração.
      InterfaceAção
      IU principal
      1. Navegar até Tudo > Ativo de Software > Licença de SaaS > Perfis de Integração Direta.
      2. Selecione Novo.
      3. Selecione o perfil de integração do DocuSign.
      Espaço de ativo do software
      1. Navegar até Operações de licença > Assinaturas de Usuário > Perfis de integração diretos.
      2. Selecione Novo.
      3. Selecione DocuSign na lista suspensa.
      4. Selecione Continuar.
    2. No formulário, preencha os campos.
      Tabela 2. Formulário Perfil de integração
      Campo Valor
      Nome de exibição Nome do perfil de integração. Por exemplo, Integração com DocuSign
      ID de Cliente ID de cliente da aplicação OAuth criada na etapa 10 na conta de administrador SaaS.
      URL de redirecionamento URL do provedor OAuth para o qual você é redirecionado após a autenticação. Este valor é preenchido automaticamente.
      ID da conta técnica ID da conta da API da sua DocuSign conta de produção.
      URL da instância URL da página de login usada para acessar sua conta de produção DocuSign. Este campo é definido automaticamente como https://account.docusign.com.
      Segredo do cliente Senha associada ao ID de cliente criado na etapa 39.
      Tipo de perfil Tipo de perfil de integração. Este valor é definido automaticamente como Assinatura do DocuSign.
    3. Revise as funções de usuário necessárias ou as permissões de API especificadas no campo Configuração do fornecedor para cada processo para minimizar os riscos de segurança e otimizar SaaS licenças.
      Nota:
      Para obter mais informações sobre as funções e os escopos necessários, consulte Tabela de permissões mínimas do usuário.

      • A caixa de seleção Baixar assinaturas está marcada por padrão e você não pode desmarcá-la.

      • A caixa de seleção Recuperar assinaturas está marcada por padrão. Se você não quiser recuperar assinaturas, poderá desmarcar esta caixa de seleção. Se você desmarcar, os candidatos a remoção serão criados, mas o subfluxo de assinatura de recuperação não será acionado ou o processo de recuperação não será iniciado.

    4. Selecione Enviar.
      Sua instância ServiceNow cria um perfil de integração de rascunho.
    5. No perfil de integração, selecione Obter token OAuth e siga as etapas para obter um token OAuth.
      Nota:
      Para a função necessária para executar esta etapa, consulte a tabela Permissões mínimas do usuário.
    6. No formulário de perfil de integração, selecione Validar conexão para verificar os detalhes de conexão e credencial desta integração.

      A validação da conexão verifica as APIs de download de assinaturas, mas não as APIs de recuperação de assinaturas.

    Resultado

    Você pode exibir eventos realizados por usuários individuais até um ano antes da data atual. Para obter mais informações, consulte Revisar uma regra de recuperação de software. Gestão de ativos de software extrai os eventos a partir do momento em que você começa a baixar assinaturas de usuário, independentemente da data de criação do perfil.

    O que Fazer Depois

    Depois que a integração se conecta, sua instância ServiceNow cria automaticamente modelos de software, regras de recuperação e assinaturas de software que são atualizadas diariamente.

    Se você quiser configurar vários perfis de integração com conexões exclusivas, crie aliases secundários para gerenciar diferentes configurações e definições para cada perfil de integração. Para obter mais informações, consulte Crie um alias secundário para configurar vários perfis de integração.

    Revise todas as regras de recuperação geradas automaticamente para recuperar assinaturas de usuário. Para obter mais informações, consulte Revisar uma regra de recuperação de software.

    Crie direitos de software para os modelos de software gerados automaticamente para rastrear o software usado em relação ao software de propriedade.
    A reconciliação também é executada em suas assinaturas como um trabalho agendado ou sob demanda. Você pode exibir os resultados da reconciliação no Workbench de licenças (Gestão de ativos de software aplicação clássica) ou na exibição de uso de licença (Software Asset Workspace). Use esses resultados para determinar sua posição de conformidade de licença e corrigir qualquer não conformidade.