Início / coding / Perguntas / 79542161
Accepted
B Reed
Asked: 2025-03-29 02:19:09 +0800 CST

Configuração do caminho do DocuSignClient com base no ambiente

  • 772

Desenvolvendo um aplicativo interno da organização para enviar envelopes/ter assinatura incorporada usando os SDKs C# do DocuSign. Seguindo os exemplos do Quickstart, consigo fazer essas ações. Como ele usa os ambientes de demonstração/teste do DocuSign, quando esse aplicativo for implantado, o código precisará fazer chamadas para o ambiente de produção do DocuSign.

Como os funcionários da organização usarão este aplicativo, não os clientes, o código usa Concessões de Código de Autorização, não Tokens JWT.

  1. Então, com a obtenção do token de acesso, o código deve chamar SetOAuthBasePath de sua instância de DocuSignClient? O SDK diz "Use este método para definir o caminho base OAuth personalizado". Mas como o DocuSign saberá o contrário?

  2. Eu assumo que a chamada de endpoint UserInfo para o BaseUri do usuário já terá o ambiente correto (já que eles foram autenticados), e o BaseUri estaria então 'apontando' para o ambiente apropriado. Verdade?

Vejo que o C# SDK tem constantes que podemos referenciar. Devo usá-las para definir quando estou no meu ambiente de produção:

public class DocuSignClient
{
    public const string Production_REST_BasePath = "https://www.docusign.net/restapi";

    public const string Demo_REST_BasePath = "https://demo.docusign.net/restapi";
...
}

public class OAuth
{
...
    public static string Demo_OAuth_BasePath = "account-d.docusign.com";

    public static string Production_OAuth_BasePath = "account.docusign.com";
}

Exemplo de código em vez de DocuSignClient docuSignClient = new DocuSignClient():

protected DocuSignClient GetDocuSignClient(bool isForAuth, bool useProd, string? userBaseUri = null)
{
    DocuSignClient rtn = new DocuSignClient();

    //DocuSignClient defaults to demo environment
    if (isForAuth && useProd)
    {
        rtn.SetOAuthBasePath(OAuth.Production_OAuth_BasePath);
    }
    
    if (!isForAuth && !string.IsNullOrEmpty(userBaseUri))
    {
        //we should have a User BaseUri, which will be based on the environment authenticated 
        rtn.SetBasePath(userBaseUri);
    }
    return rtn;
}
docusignapi

1 respostas

  1. Best Answer

    Os SDKs usam dois URLs de caminho base: um para o serviço OAuth e outro para o serviço REST API.

    Esses caminhos são definidos por padrão para o sistema do desenvolvedor (demonstração).

    Para produção você deve:

    1. Defina explicitamente o URL OAuth ( SetOAuthBasePath) para o sistema OAuth de produção

    2. Após o usuário efetuar login, chame UserInfopara determinar as informações do usuário, incluindo o caminho base da API, usado pela conta do usuário que será usada (sua conta padrão ou outra).

    3. Defina o caminho base da API REST do SDK usando os dados da etapa 2.

    Definindo o caminho base da API

    O BaseUriatributo na resposta UserInfo não termina com /restapi, necessário para o serviço REST API. Então você precisa adicioná-lo explicitamente. Aqui está um exemplo do conjunto de testes do C# SDK que procura a conta padrão na resposta UserInfo. Link

    foreach (OAuth.UserInfo.Account item in userInfo.Accounts)
{
    if (item.IsDefault == "true")
    {
        testConfig.AccountId = item.AccountId;
        testConfig.ApiClient.SetBasePath(item.BaseUri + "/restapi");
        break;
    }
}

    O problema subjacente é que o ambiente de desenvolvedor Docusign (demonstração) tem exatamente um caminho base de API. Em contraste, os sistemas de produção têm muitos caminhos base de API. Seu código precisa determinar qual caminho base de API é o certo para a conta da qual o usuário atual é membro (pode haver mais de uma conta).

    Observe que a chamada UserInfo é usada com o serviço OAuth . É por isso que ela funciona mesmo que você ainda não saiba o caminho base da API para o usuário.

    Contas múltiplas

    Os usuários pertencem a uma conta padrão. Eles também, frequentemente, podem pertencer a várias contas. É uma boa ideia permitir que seus usuários usem suas contas padrão por padrão, mas também permitir que eles alterem qual conta será usada. E permitir que seus usuários, para seu aplicativo, alterem seus padrões.

    Suas perguntas

    1. Então, ao obter o token de acesso, o código deve chamar SetOAuthBasePath de sua instância de DocuSignClient? O SDK diz "Use este método para definir o caminho base OAuth personalizado". Mas como o DocuSign saberá o contrário?
      [Você deve chamar SetOAuthBasePath explicitamente. O padrão é demo.]

    2. Presumo que a chamada de endpoint UserInfo para o BaseUri do usuário já terá o ambiente correto (já que eles foram autenticados), e o BaseUri estaria então 'apontando' para o ambiente apropriado. Verdade?
      [O BaseUri não é usado para o endpoint UserInfo, o caminho base OAuth é usado.]

    • 1

relate perguntas