Integração com DocuSign

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

    • Integrando seu Gestão de ativos de softwareaplicação com DocuSigno serviço permite que você rastreie suas assinaturas de software e recupere licenças não utilizadas.

    DocuSignas compras feitas por meio de revendedores não se refletem em DocuSignsistema de faturamento padrão. Portanto, nenhum valor é retornado por meio das APIs para consumo de envelope que está disponível para ServiceNow.

    Nota:
    DocuSignremoveu o. Último login Campo da API de usuários. Portanto, as últimas atividades dos usuários não são rastreadas como parte desta integração.

    Para obter mais informações sobre DocuSignserviço, consulte O site do desenvolvedor DocuSign .

    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 de usuário necessária no DocuSignaplicação Escopos de autenticação
    Download de assinaturas administrador Nenhum escopo
    Recuperar assinatura administrador Nenhum escopo

    Registre um DocuSignaplicação

    Registre um DocuSignaplicação por meio de DocuSignportal do administrador.

    Antes de Iniciar

    DocuSign Função necessária: administrador

    Procedimento

    1. Faça login em DocuSignconta de demonstração (não produção).
    2. Selecione sua imagem de perfil.
    3. Selecione Minhas aplicações e chaves .
      • Se você já tiver uma chave de integração de API de uma integração anterior pronta para uso na produção, vá para a etapa 33 .
      • Se você não tiver o segredo do cliente salvo, será necessário gerar um novo segredo.
    4. No painel esquerdo, selecione INTEGRAÇÕES > Apps e chaves.
    5. Em Apps e chaves de integração , selecione ADICIONE APP E CHAVE DE INTEGRAÇÃO .
    6. No formulário Adicionar chave de integração, forneça um nome no Nome da aplicação e selecione CRIAR APP .
    7. Selecione ADICIONAR URI em URIs de redirecionamento campo no Configurações adicionais seção.
    8. Adicionar https://oauth.pstmn.io/v1/browser-callback .
    9. Selecione ADICIONAR URI novamente e adicione https:// Instância da ServiceNow .service-now.com/oauth_redirect.do .
    10. Selecione ADICIONE CHAVE SECRETA .
      Salve a chave de integração (ID do cliente) e a chave secreta (segredo do cliente) em um local seguro para usá-los posteriormente no aplicativo Postman e a chave de integração (ID do cliente) no ServiceNowinstância.
    11. Selecione Salvar.
    12. Baixe a versão mais recente de App Postman e ignore o login.
    13. Selecionar Nova coleção e forneça um nome para a coleção.
    14. Selecione Autorização .
    15. No menu da lista Tipo, selecione OAuth 2,0 .
    16. Forneça um nome e preencha os campos no Opções de configuração guia 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 do seu DocuSignconta de demonstração criada em etapa 10 .
      Segredo do cliente A chave secreta do seu DocuSignconta 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 estiver 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 a URL no campo OBTER como https://account-d.docusign.com/oauth/userinfo .
    22. Na guia Cabeçalhos, selecione Autorização em CHAVE e insira Portador Token de acesso que você copiou durante a autenticação> em Valor .
    23. Selecione Enviar e verifique se sua solicitação foi concluída.
      O ID da conta é exibido no corpo da resposta.
    24. Duplicar a solicitação GET.
      Copie a chave de autorização e o valor em Cabeçalhos .
    25. Atualize o URL no campo OBTER como https://demo.docusign.net/restapi/v2/accounts/<account-id>/usuários .
      Aqui, id da conta É 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 DocuSignportal do administrador.
    27. Navegue até Apps e chaves de integração em DocuSignportal do administrador.
    28. Selecionar Ações > Exibir painel de API ao lado da sua aplicação.
    29. Aguarde alguns minutos por DocuSignPara registrar todas as 20 chamadas de API.
    30. Navegar até INTEGRAÇÕES > Apps e chaves e selecione Enviar para revisão .
      Após 5-20 minutos, a revisão da sua candidatura estará concluída. Você pode promover a aplicação para sua conta de produção.
    31. Selecionar Ações > Revisão de Iniciar-Ir- em tempo real 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 em DocuSignconta de conteúdo de produção.
    34. Selecione sua imagem de perfil.
    35. Selecione Vá para Administrador .
    36. No painel esquerdo, selecione INTEGRAÇÕES > Apps e chaves.
      Localize o ID da conta da API a ser usado para o perfil de integração no ServiceNowinstância.
    37. Ao lado da sua aplicação, selecione Ações > Editar.
    38. Selecione ADICIONAR URI e adicionar https:// Instância da ServiceNow .service-now.com/oauth_redirect.do .
    39. Selecione ADICIONE CHAVE SECRETA .
      Salve a chave secreta (segredo do cliente) da sua conta de produção em um local seguro para usá-la no ServiceNowinstância.
    40. Selecione Salvar.

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

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

    Antes de Iniciar

    Para criar um DocuSignperfil de integração, solicite o. Gestão de ativos de software- Gestão de licenças de SaaSplug-in (sn_sam_saas_int) do ServiceNow Store .

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

    Por Que e Quando Desempenhar Esta Tarefa

    Se você estiver usando Espaço para ativos de software, a opção para criar o. DocuSignperfil de integração em IU principalestá inativo.

    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 Perfil de integração DocuSign .
      Espaço de ativos de 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 de 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 do cliente para a aplicação OAuth criada em etapa 10 em SaaSconta de administrador.
      URL de redirecionamento URL do provedor OAuth para o qual você foi redirecionado após a autenticação. Este valor é preenchido automaticamente.
      ID da conta técnica ID da conta da API do seu DocuSignconta de produção.
      URL da instância URL da página de login usada para acessar o. DocuSignconta de produção. Este campo é definido automaticamente como https://account.docusign.com .
      Segredo do cliente Senha associada ao ID do cliente criado em etapa 39 .
      Tipo de perfil Tipo de perfil de integração. Este valor é definido automaticamente como Assinatura DocuSign .
    3. Revise as funções de usuário necessárias ou as permissões de API especificadas no Configuração do fornecedor campo para cada processo para minimizar os riscos de segurança e otimizar SaaSlicenças.
      Nota:
      Para obter mais informações sobre as funções e escopos necessários, consulte Permissões mínimas do usuário tabela.

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

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

    4. Selecione Enviar.
      Seu ServiceNowa instância 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 obter a função necessária para executar esta etapa, consulte Permissões mínimas do usuário tabela.
    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 Revise uma regra de recuperação de software. Gestão de ativos de softwareextrai os eventos 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

    Após a integração se conectar, seu ServiceNowa instância 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 configuraçõ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 Revise 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 próprio.
    A reconciliação também é executada em suas assinaturas como um trabalho agendado ou sob demanda. Você pode exibir seus resultados de reconciliação no Workbench de licença ( Gestão de ativos de softwareaplicação clássica) ou o. Exibição de uso de licença (Espaço de ativos de software). Use estes resultados para determinar sua posição de conformidade de licença e corrigir qualquer não conformidade.